{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"title": "WebApps API Client",
"version": "2019-08-01",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json",
"version": "2.0"
}
],
"x-preferred": false,
"x-providerName": "azure.com",
"x-serviceName": "web-WebApps",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {
"apiVersionParameter": {
"description": "API Version",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
"resourceGroupNameParameter": {
"description": "Name of the resource group to which the resource belongs.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"subscriptionIdParameter": {
"description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
}
},
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": {
"get": {
"description": "Description for Get all apps for a subscription.",
"operationId": "WebApps_List",
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of App Service apps.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get all apps for a subscription.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites": {
"get": {
"description": "Description for Gets all web, mobile, and API apps in the specified resource group.",
"operationId": "WebApps_ListByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps.",
"in": "query",
"name": "includeSlots",
"type": "boolean"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of App Service apps.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets all web, mobile, and API apps in the specified resource group.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}": {
"delete": {
"description": "Description for Deletes a web, mobile, or API app, or one of the deployment slots.",
"operationId": "WebApps_Delete",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app to delete.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "If true, web app metrics are also deleted.",
"in": "query",
"name": "deleteMetrics",
"type": "boolean"
},
{
"description": "Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.",
"in": "query",
"name": "deleteEmptyServerFarm",
"type": "boolean"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted web app."
},
"204": {
"description": "Successfully deleted web app."
},
"404": {
"description": "Web app not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a web, mobile, or API app, or one of the deployment slots.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets the details of a web, mobile, or API app.",
"operationId": "WebApps_Get",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"404": {
"description": "Not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the details of a web, mobile, or API app.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"operationId": "WebApps_Update",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the app properties. See example.",
"in": "body",
"name": "siteEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/SitePatchResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"202": {
"description": "Asynchronous operation in progress.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"operationId": "WebApps_CreateOrUpdate",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the app properties. See example.",
"in": "body",
"name": "siteEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"202": {
"description": "Asynchronous operation in progress.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname": {
"get": {
"description": "Description for Analyze a custom hostname.",
"operationId": "WebApps_AnalyzeCustomHostname",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Custom hostname.",
"in": "query",
"name": "hostName",
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CustomHostnameAnalysisResult"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Analyze a custom hostname.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig": {
"post": {
"description": "Description for Applies the configuration settings from the target slot onto the current slot.",
"operationId": "WebApps_ApplySlotConfigToProduction",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON object that contains the target slot name. See example.",
"in": "body",
"name": "slotSwapEntity",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Applies the configuration settings from the target slot onto the current slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": {
"post": {
"description": "Description for Creates a backup of an app.",
"operationId": "WebApps_Backup",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Backup configuration. You can use the JSON response from the POST action as input here.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a backup of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": {
"get": {
"description": "Description for Gets existing backups of an app.",
"operationId": "WebApps_ListBackups",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItemCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets existing backups of an app.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": {
"delete": {
"description": "Description for Deletes a backup of an app by its ID.",
"operationId": "WebApps_DeleteBackup",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of the backup.",
"in": "path",
"name": "backupId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted web app backup item."
},
"404": {
"description": "Web app backup item does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a backup of an app by its ID.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a backup of an app by its ID.",
"operationId": "WebApps_GetBackupStatus",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of the backup.",
"in": "path",
"name": "backupId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a backup of an app by its ID.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": {
"post": {
"description": "Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
"operationId": "WebApps_ListBackupStatusSecrets",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of backup.",
"in": "path",
"name": "backupId",
"required": true,
"type": "string"
},
{
"description": "Information on backup request.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore": {
"post": {
"description": "Description for Restores a specific backup to another app (or deployment slot, if specified).",
"operationId": "WebApps_Restore",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of the backup.",
"in": "path",
"name": "backupId",
"required": true,
"type": "string"
},
{
"description": "Information on restore request .",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Restore operation started."
},
"202": {
"description": "Restore operation started."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores a specific backup to another app (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config": {
"get": {
"description": "Description for List the configurations of an app",
"operationId": "WebApps_ListConfigurations",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResourceCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List the configurations of an app",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings": {
"put": {
"description": "Description for Replaces the application settings of an app.",
"operationId": "WebApps_UpdateApplicationSettings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Application settings of the app.",
"in": "body",
"name": "appSettings",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Replaces the application settings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": {
"post": {
"description": "Description for Gets the application settings of an app.",
"operationId": "WebApps_ListApplicationSettings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the application settings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": {
"put": {
"description": "Description for Updates the Authentication / Authorization settings associated with web app.",
"operationId": "WebApps_UpdateAuthSettings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Auth settings associated with web app.",
"in": "body",
"name": "siteAuthSettings",
"required": true,
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the Authentication / Authorization settings associated with web app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": {
"post": {
"description": "Description for Gets the Authentication/Authorization settings of an app.",
"operationId": "WebApps_GetAuthSettings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the Authentication/Authorization settings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts": {
"put": {
"description": "Description for Updates the Azure storage account configurations of an app.",
"operationId": "WebApps_UpdateAzureStorageAccounts",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Azure storage accounts of the app.",
"in": "body",
"name": "azureStorageAccounts",
"required": true,
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the Azure storage account configurations of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list": {
"post": {
"description": "Description for Gets the Azure storage account configurations of an app.",
"operationId": "WebApps_ListAzureStorageAccounts",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the Azure storage account configurations of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": {
"delete": {
"description": "Description for Deletes the backup configuration of an app.",
"operationId": "WebApps_DeleteBackupConfiguration",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted backup configuration."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes the backup configuration of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the backup configuration of an app.",
"operationId": "WebApps_UpdateBackupConfiguration",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Edited backup configuration.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the backup configuration of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": {
"post": {
"description": "Description for Gets the backup configuration of an app.",
"operationId": "WebApps_GetBackupConfiguration",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the backup configuration of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings": {
"get": {
"description": "Description for Gets the config reference app settings and status of an app",
"operationId": "WebApps_GetAppSettingsKeyVaultReferences",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/KeyVaultReferenceCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the config reference app settings and status of an app",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get Azure Key Vault references for app settings": {
"parameters": {
"api-version": "2019-08-01",
"name": "tests346",
"resourceGroupName": "testrg123",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/config/configreferences/appsettings",
"name": "testc6282",
"properties": {
"keyToReferenceStatuses": {
"ref1": {
"details": "Some Details",
"identityType": "None",
"location": "ApplicationSetting",
"reference": "referenceName",
"secretName": "testsec579",
"secretVersion": "239",
"source": "KeyVault",
"status": "Resolved",
"vaultName": "testkv124"
}
}
},
"type": "Microsoft.Web/sites/config/appsettings"
},
"headers": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey}": {
"get": {
"description": "Description for Gets the config reference and status of an app",
"operationId": "WebApps_GetAppSettingKeyVaultReference",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "App Setting key name.",
"in": "path",
"name": "appSettingKey",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/KeyVaultReferenceResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the config reference and status of an app",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get Azure Key Vault app setting reference": {
"parameters": {
"api-version": "2019-08-01",
"appSettingKey": "ref1",
"name": "tests346",
"resourceGroupName": "testrg123",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/config/configreferences/appsettings/ref1",
"name": "testc6282",
"properties": {
"details": "Some Details",
"identityType": "None",
"location": "ApplicationSetting",
"reference": "referenceName",
"secretName": "testsec579",
"secretVersion": "239",
"source": "KeyVault",
"status": "Resolved",
"vaultName": "testkv124"
},
"type": "Microsoft.Web/sites/config/appsettings"
},
"headers": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": {
"put": {
"description": "Description for Replaces the connection strings of an app.",
"operationId": "WebApps_UpdateConnectionStrings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Connection strings of the app or deployment slot. See example.",
"in": "body",
"name": "connectionStrings",
"required": true,
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Replaces the connection strings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": {
"post": {
"description": "Description for Gets the connection strings of an app.",
"operationId": "WebApps_ListConnectionStrings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the connection strings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": {
"get": {
"description": "Description for Gets the logging configuration of an app.",
"operationId": "WebApps_GetDiagnosticLogsConfiguration",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the logging configuration of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the logging configuration of an app.",
"operationId": "WebApps_UpdateDiagnosticLogsConfig",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.",
"in": "body",
"name": "siteLogsConfig",
"required": true,
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the logging configuration of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": {
"put": {
"description": "Description for Replaces the metadata of an app.",
"operationId": "WebApps_UpdateMetadata",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Edited metadata of the app or deployment slot. See example.",
"in": "body",
"name": "metadata",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Replaces the metadata of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": {
"post": {
"description": "Description for Gets the metadata of an app.",
"operationId": "WebApps_ListMetadata",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the metadata of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list": {
"post": {
"description": "Description for Gets the Git/FTP publishing credentials of an app.",
"operationId": "WebApps_ListPublishingCredentials",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "User credentials used for publishing activity.",
"properties": {
"properties": {
"description": "User resource specific properties",
"properties": {
"publishingPassword": {
"description": "Password used for publishing.",
"format": "password",
"type": "string"
},
"publishingPasswordHash": {
"description": "Password hash used for publishing.",
"format": "password",
"type": "string"
},
"publishingPasswordHashSalt": {
"description": "Password hash salt used for publishing.",
"format": "password",
"type": "string"
},
"publishingUserName": {
"description": "Username used for publishing.",
"type": "string"
},
"scmUri": {
"description": "Url of SCM site.",
"type": "string"
}
},
"required": [
"publishingUserName"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the Git/FTP publishing credentials of an app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings": {
"put": {
"description": "Description for Updates the Push settings associated with web app.",
"operationId": "WebApps_UpdateSitePushSettings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Push settings associated with web app.",
"in": "body",
"name": "pushSettings",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the Push settings associated with web app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list": {
"post": {
"description": "Description for Gets the Push settings associated with web app.",
"operationId": "WebApps_ListSitePushSettings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the Push settings associated with web app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames": {
"get": {
"description": "Description for Gets the names of app settings and connection strings that stick to the slot (not swapped).",
"operationId": "WebApps_ListSlotConfigurationNames",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SlotConfigNamesResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the names of app settings and connection strings that stick to the slot (not swapped).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the names of application settings and connection string that remain with the slot during swap operation.",
"operationId": "WebApps_UpdateSlotConfigurationNames",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Names of application settings and connection strings. See example.",
"in": "body",
"name": "slotConfigNames",
"required": true,
"schema": {
"$ref": "#/definitions/SlotConfigNamesResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SlotConfigNamesResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the names of application settings and connection string that remain with the slot during swap operation.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": {
"get": {
"description": "Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
"operationId": "WebApps_GetConfiguration",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Updates the configuration of an app.",
"operationId": "WebApps_UpdateConfiguration",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON representation of a SiteConfig object. See example.",
"in": "body",
"name": "siteConfig",
"required": true,
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the configuration of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the configuration of an app.",
"operationId": "WebApps_CreateOrUpdateConfiguration",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON representation of a SiteConfig object. See example.",
"in": "body",
"name": "siteConfig",
"required": true,
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the configuration of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots": {
"get": {
"description": "Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
"operationId": "WebApps_ListConfigurationSnapshotInfo",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}": {
"get": {
"description": "Description for Gets a snapshot of the configuration of an app at a previous point in time.",
"operationId": "WebApps_GetConfigurationSnapshot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The ID of the snapshot to read.",
"in": "path",
"name": "snapshotId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a snapshot of the configuration of an app at a previous point in time.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover": {
"post": {
"description": "Description for Reverts the configuration of an app to a previous snapshot.",
"operationId": "WebApps_RecoverSiteConfigurationSnapshot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The ID of the snapshot to read.",
"in": "path",
"name": "snapshotId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Reverts the configuration of an app to a previous snapshot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs": {
"post": {
"description": "Description for Gets the last lines of docker logs for the given site",
"operationId": "WebApps_GetWebSiteContainerLogs",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"produces": [
"application/octet-stream"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the last lines of docker logs for the given site",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download": {
"post": {
"description": "Description for Gets the ZIP archived docker log files for the given site",
"operationId": "WebApps_GetContainerLogsZip",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"produces": [
"application/zip"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the ZIP archived docker log files for the given site",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs": {
"get": {
"description": "Description for List continuous web jobs for an app, or a deployment slot.",
"operationId": "WebApps_ListContinuousWebJobs",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContinuousWebJobCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List continuous web jobs for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}": {
"delete": {
"description": "Description for Delete a continuous web job by its ID for an app, or a deployment slot.",
"operationId": "WebApps_DeleteContinuousWebJob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted continuous web job."
},
"204": {
"description": "Continuous web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a continuous web job by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a continuous web job by its ID for an app, or a deployment slot.",
"operationId": "WebApps_GetContinuousWebJob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job.",
"schema": {
"$ref": "#/definitions/ContinuousWebJob"
}
},
"404": {
"description": "Continuous web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a continuous web job by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start": {
"post": {
"description": "Description for Start a continuous web job for an app, or a deployment slot.",
"operationId": "WebApps_StartContinuousWebJob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job."
},
"404": {
"description": "Continuous web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Start a continuous web job for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop": {
"post": {
"description": "Description for Stop a continuous web job for an app, or a deployment slot.",
"operationId": "WebApps_StopContinuousWebJob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job."
},
"404": {
"description": "Continuous web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Stop a continuous web job for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": {
"get": {
"description": "Description for List deployments for an app, or a deployment slot.",
"operationId": "WebApps_ListDeployments",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DeploymentCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List deployments for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}": {
"delete": {
"description": "Description for Delete a deployment by its ID for an app, or a deployment slot.",
"operationId": "WebApps_DeleteDeployment",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Deployment ID.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted deployment."
},
"204": {
"description": "Deployment does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a deployment by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get a deployment by its ID for an app, or a deployment slot.",
"operationId": "WebApps_GetDeployment",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Deployment ID.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get a deployment by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Create a deployment for an app, or a deployment slot.",
"operationId": "WebApps_CreateDeployment",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of an existing deployment.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Deployment details.",
"in": "body",
"name": "deployment",
"required": true,
"schema": {
"$ref": "#/definitions/Deployment"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Create a deployment for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log": {
"get": {
"description": "Description for List deployment log for specific deployment for an app, or a deployment slot.",
"operationId": "WebApps_ListDeploymentLog",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List deployment log for specific deployment for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup": {
"post": {
"description": "Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
"operationId": "WebApps_DiscoverBackup",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers": {
"get": {
"description": "Description for Lists ownership identifiers for domain associated with web app.",
"operationId": "WebApps_ListDomainOwnershipIdentifiers",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of identifiers.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Lists ownership identifiers for domain associated with web app.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": {
"delete": {
"description": "Description for Deletes a domain ownership identifier for a web app.",
"operationId": "WebApps_DeleteDomainOwnershipIdentifier",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of domain ownership identifier.",
"in": "path",
"name": "domainOwnershipIdentifierName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted domain ownership identifier."
},
"204": {
"description": "Domain ownership identifier does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a domain ownership identifier for a web app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get domain ownership identifier for web app.",
"operationId": "WebApps_GetDomainOwnershipIdentifier",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of domain ownership identifier.",
"in": "path",
"name": "domainOwnershipIdentifierName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get domain ownership identifier for web app.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"operationId": "WebApps_UpdateDomainOwnershipIdentifier",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of domain ownership identifier.",
"in": "path",
"name": "domainOwnershipIdentifierName",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the domain ownership properties.",
"in": "body",
"name": "domainOwnershipIdentifier",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifier",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of domain ownership identifier.",
"in": "path",
"name": "domainOwnershipIdentifierName",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the domain ownership properties.",
"in": "body",
"name": "domainOwnershipIdentifier",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy": {
"get": {
"description": "Description for Get the status of the last MSDeploy operation.",
"operationId": "WebApps_GetMSDeployStatus",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the status of the last MSDeploy operation.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Invoke the MSDeploy web app extension.",
"operationId": "WebApps_CreateMSDeployOperation",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Details of MSDeploy operation",
"in": "body",
"name": "MSDeploy",
"required": true,
"schema": {
"$ref": "#/definitions/MSDeploy"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"201": {
"description": "Deployment is scheduled.",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"409": {
"description": "Another deployment is in progress."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Invoke the MSDeploy web app extension.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log": {
"get": {
"description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
"operationId": "WebApps_GetMSDeployLog",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "MSDeploy log returned.",
"schema": {
"$ref": "#/definitions/MSDeployLog"
}
},
"404": {
"description": "MSDeploy log not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the MSDeploy Log for the last MSDeploy operation.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions": {
"get": {
"description": "Description for List the functions for a web site, or a deployment slot.",
"operationId": "WebApps_ListFunctions",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Function information returned.",
"schema": {
"$ref": "#/definitions/FunctionEnvelopeCollection"
}
},
"404": {
"description": "Function with an ID of {functionName} is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List the functions for a web site, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token": {
"get": {
"description": "Description for Fetch a short lived token that can be exchanged for a master key.",
"operationId": "WebApps_GetFunctionsAdminToken",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Fetch a short lived token that can be exchanged for a master key.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}": {
"delete": {
"description": "Description for Delete a function for web site, or a deployment slot.",
"operationId": "WebApps_DeleteFunction",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Function deleted."
},
"404": {
"description": "Function does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a function for web site, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get function information by its ID for web site, or a deployment slot.",
"operationId": "WebApps_GetFunction",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Function information returned.",
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
"404": {
"description": "Function with a name of {functionName} does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get function information by its ID for web site, or a deployment slot.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Create function for web site, or a deployment slot.",
"operationId": "WebApps_CreateFunction",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "Function details.",
"in": "body",
"name": "function_envelope",
"required": true,
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"201": {
"description": "Function created.",
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Create function for web site, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName}": {
"delete": {
"description": "Description for Delete a function secret.",
"operationId": "WebApps_DeleteFunctionSecret",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The name of the function.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "The name of the key.",
"in": "path",
"name": "keyName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Key was deleted."
},
"404": {
"description": "Key was not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a function secret.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Add or update a function secret.",
"operationId": "WebApps_CreateOrUpdateFunctionSecret",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The name of the function.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "The name of the key.",
"in": "path",
"name": "keyName",
"required": true,
"type": "string"
},
{
"description": "The key to create or update",
"in": "body",
"name": "key",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Key was updated.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"201": {
"description": "Key was created.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Add or update a function secret.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys": {
"post": {
"description": "Description for Get function keys for a function in a web site, or a deployment slot.",
"operationId": "WebApps_ListFunctionKeys",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Function keys returned.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get function keys for a function in a web site, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets": {
"post": {
"description": "Description for Get function secrets for a function in a web site, or a deployment slot.",
"operationId": "WebApps_ListFunctionSecrets",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Function secrets returned.",
"schema": {
"$ref": "#/definitions/FunctionSecrets"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get function secrets for a function in a web site, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys": {
"post": {
"description": "Description for Get host secrets for a function app.",
"operationId": "WebApps_ListHostKeys",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Host secrets returned.",
"schema": {
"$ref": "#/definitions/HostKeys"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get host secrets for a function app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus": {
"post": {
"description": "Description for This is to allow calling via powershell and ARM template.",
"operationId": "WebApps_ListSyncStatus",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "This is to allow calling via powershell and ARM template.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync": {
"post": {
"description": "Description for Syncs function trigger metadata to the management database",
"operationId": "WebApps_SyncFunctions",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Syncs function trigger metadata to the management database",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}": {
"delete": {
"description": "Description for Delete a host level secret.",
"operationId": "WebApps_DeleteHostSecret",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The type of host key.",
"in": "path",
"name": "keyType",
"required": true,
"type": "string"
},
{
"description": "The name of the key.",
"in": "path",
"name": "keyName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Key was deleted."
},
"404": {
"description": "Key was not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a host level secret.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Add or update a host level secret.",
"operationId": "WebApps_CreateOrUpdateHostSecret",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The type of host key.",
"in": "path",
"name": "keyType",
"required": true,
"type": "string"
},
{
"description": "The name of the key.",
"in": "path",
"name": "keyName",
"required": true,
"type": "string"
},
{
"description": "The key to create or update",
"in": "body",
"name": "key",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Key was updated.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"201": {
"description": "Key was created.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Add or update a host level secret.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": {
"get": {
"description": "Description for Get hostname bindings for an app or a deployment slot.",
"operationId": "WebApps_ListHostNameBindings",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/HostNameBindingCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get hostname bindings for an app or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": {
"delete": {
"description": "Description for Deletes a hostname binding for an app.",
"operationId": "WebApps_DeleteHostNameBinding",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Hostname in the hostname binding.",
"in": "path",
"name": "hostName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted hostname binding."
},
"204": {
"description": "Hostname binding does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a hostname binding for an app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get the named hostname binding for an app (or deployment slot, if specified).",
"operationId": "WebApps_GetHostNameBinding",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Hostname in the hostname binding.",
"in": "path",
"name": "hostName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the named hostname binding for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a hostname binding for an app.",
"operationId": "WebApps_CreateOrUpdateHostNameBinding",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Hostname in the hostname binding.",
"in": "path",
"name": "hostName",
"required": true,
"type": "string"
},
{
"description": "Binding details. This is the JSON representation of a HostNameBinding object.",
"in": "body",
"name": "hostNameBinding",
"required": true,
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a hostname binding for an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": {
"delete": {
"description": "Description for Removes a Hybrid Connection from this site.",
"operationId": "WebApps_DeleteHybridConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The namespace for this hybrid connection.",
"in": "path",
"name": "namespaceName",
"required": true,
"type": "string"
},
{
"description": "The relay name for this hybrid connection.",
"in": "path",
"name": "relayName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted hybrid connection."
},
"404": {
"description": "Hybrid connection does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Removes a Hybrid Connection from this site.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
"operationId": "WebApps_GetHybridConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The namespace for this hybrid connection.",
"in": "path",
"name": "namespaceName",
"required": true,
"type": "string"
},
{
"description": "The relay name for this hybrid connection.",
"in": "path",
"name": "relayName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
"operationId": "WebApps_UpdateHybridConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The namespace for this hybrid connection.",
"in": "path",
"name": "namespaceName",
"required": true,
"type": "string"
},
{
"description": "The relay name for this hybrid connection.",
"in": "path",
"name": "relayName",
"required": true,
"type": "string"
},
{
"description": "The details of the hybrid connection.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new Hybrid Connection using a Service Bus relay.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
"operationId": "WebApps_CreateOrUpdateHybridConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The namespace for this hybrid connection.",
"in": "path",
"name": "namespaceName",
"required": true,
"type": "string"
},
{
"description": "The relay name for this hybrid connection.",
"in": "path",
"name": "relayName",
"required": true,
"type": "string"
},
{
"description": "The details of the hybrid connection.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new Hybrid Connection using a Service Bus relay.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": {
"get": {
"description": "Description for Retrieves all Service Bus Hybrid Connections used by this Web App.",
"operationId": "WebApps_ListHybridConnections",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": {
"get": {
"description": "Description for Gets hybrid connections configured for an app (or deployment slot, if specified).",
"operationId": "WebApps_ListRelayServiceConnections",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": {
"delete": {
"description": "Description for Deletes a relay service connection by its name.",
"operationId": "WebApps_DeleteRelayServiceConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the hybrid connection configuration.",
"in": "path",
"name": "entityName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted relay service connection."
},
"404": {
"description": "Relay service connection does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a relay service connection by its name.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a hybrid connection configuration by its name.",
"operationId": "WebApps_GetRelayServiceConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the hybrid connection.",
"in": "path",
"name": "entityName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a hybrid connection configuration by its name.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"operationId": "WebApps_UpdateRelayServiceConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the hybrid connection configuration.",
"in": "path",
"name": "entityName",
"required": true,
"type": "string"
},
{
"description": "Details of the hybrid connection configuration.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"operationId": "WebApps_CreateOrUpdateRelayServiceConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the hybrid connection configuration.",
"in": "path",
"name": "entityName",
"required": true,
"type": "string"
},
{
"description": "Details of the hybrid connection configuration.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": {
"get": {
"description": "Description for Gets all scale-out instances of an app.",
"operationId": "WebApps_ListInstanceIdentifiers",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebAppInstanceCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets all scale-out instances of an app.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}": {
"get": {
"description": "Description for Gets all scale-out instances of an app.",
"operationId": "WebApps_GetInstanceInfo",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebSiteInstanceStatus"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets all scale-out instances of an app.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get site instance info": {
"parameters": {
"api-version": "2019-08-01",
"instanceId": "134987120",
"name": "tests346",
"resourceGroupName": "testrg123",
"slot": "staging",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging/instances/134987120",
"name": "134987120",
"properties": {
"containers": {
"c1": {
"currentTimeStamp": "2013-10-21T13:28:06.419Z"
}
},
"detectorUrl": "testsec579",
"state": "READY",
"statusUrl": "https://sampleurl"
},
"type": "Microsoft.Web/sites/instances"
},
"headers": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": {
"get": {
"description": "Description for Get the status of the last MSDeploy operation.",
"operationId": "WebApps_GetInstanceMsDeployStatus",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of web app instance.",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the status of the last MSDeploy operation.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Invoke the MSDeploy web app extension.",
"operationId": "WebApps_CreateInstanceMSDeployOperation",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of web app instance.",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"description": "Details of MSDeploy operation",
"in": "body",
"name": "MSDeploy",
"required": true,
"schema": {
"$ref": "#/definitions/MSDeploy"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"201": {
"description": "Deployment is scheduled.",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"409": {
"description": "Another deployment is in progress."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Invoke the MSDeploy web app extension.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": {
"get": {
"description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
"operationId": "WebApps_GetInstanceMSDeployLog",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of web app instance.",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "MSDeploy log returned.",
"schema": {
"$ref": "#/definitions/MSDeployLog"
}
},
"404": {
"description": "MSDeploy log not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the MSDeploy Log for the last MSDeploy operation.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": {
"get": {
"description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListInstanceProcesses",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Process terminated.",
"schema": {
"$ref": "#/definitions/ProcessInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": {
"delete": {
"description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"operationId": "WebApps_DeleteInstanceProcess",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Process terminated."
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetInstanceProcess",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Process information returned.",
"schema": {
"$ref": "#/definitions/ProcessInfo"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": {
"get": {
"description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetInstanceProcessDump",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": {
"get": {
"description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListInstanceProcessModules",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Module information returned.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": {
"get": {
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetInstanceProcessModule",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Module base address.",
"in": "path",
"name": "baseAddress",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Module information returned.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"404": {
"description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": {
"get": {
"description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListInstanceProcessThreads",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Thread information returned.",
"schema": {
"$ref": "#/definitions/ProcessThreadInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": {
"post": {
"description": "Description for Shows whether an app can be cloned to another resource group or subscription.",
"operationId": "WebApps_IsCloneable",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/SiteCloneability"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Shows whether an app can be cloned to another resource group or subscription.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listbackups": {
"post": {
"description": "Description for Gets existing backups of an app.",
"operationId": "WebApps_ListSiteBackups",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItemCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets existing backups of an app.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"List backups": {
"parameters": {
"api-version": "2019-08-01",
"name": "tests346",
"resourceGroupName": "testrg123",
"slot": "staging",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging",
"name": "tests346/staging",
"properties": {
"blobName": "blob1",
"status": "InProgress",
"storageAccountUrl": "https://blobstorage.windows.net"
},
"type": "Microsoft.Web/sites/slots"
}
]
},
"headers": {}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": {
"post": {
"description": "Description for This is to allow calling via powershell and ARM template.",
"operationId": "WebApps_ListSyncFunctionTriggers",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FunctionSecrets"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "This is to allow calling via powershell and ARM template.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": {
"put": {
"description": "Description for Restores a web app.",
"operationId": "WebApps_MigrateStorage",
"parameters": [
{
"description": "Azure subscription.",
"in": "query",
"name": "subscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Migration migrationOptions.",
"in": "body",
"name": "migrationOptions",
"required": true,
"schema": {
"$ref": "#/definitions/StorageMigrationOptions"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StorageMigrationResponse"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores a web app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": {
"post": {
"description": "Description for Migrates a local (in-app) MySql database to a remote MySql database.",
"operationId": "WebApps_MigrateMySql",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "MySql migration options.",
"in": "body",
"name": "migrationRequestEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/MigrateMySqlRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "An operation on a resource.",
"properties": {
"createdTime": {
"description": "Time when operation has started.",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Any errors associate with the operation.",
"items": {
"description": "Body of the error response returned from the API.",
"properties": {
"code": {
"description": "Basic error code.",
"type": "string"
},
"extendedCode": {
"description": "Type of error.",
"type": "string"
},
"innerErrors": {
"description": "Inner errors.",
"items": {
"$ref": "#/definitions/ErrorEntity"
},
"type": "array"
},
"message": {
"description": "Any details of the error.",
"type": "string"
},
"messageTemplate": {
"description": "Message template.",
"type": "string"
},
"parameters": {
"description": "Parameters for the template.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"expirationTime": {
"description": "Time when operation will expire.",
"format": "date-time",
"type": "string"
},
"geoMasterOperationId": {
"description": "Applicable only for stamp operation ids.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"id": {
"description": "Operation ID.",
"type": "string"
},
"modifiedTime": {
"description": "Time when operation has been updated.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Operation name.",
"type": "string"
},
"status": {
"description": "The current status of the operation.",
"enum": [
"InProgress",
"Failed",
"Succeeded",
"TimedOut",
"Created"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "OperationStatus"
}
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Migrates a local (in-app) MySql database to a remote MySql database.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": {
"get": {
"description": "Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
"operationId": "WebApps_GetMigrateMySqlStatus",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MigrateMySqlStatus"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": {
"delete": {
"description": "Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).",
"operationId": "WebApps_DeleteSwiftVirtualNetwork",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted virtual network."
},
"404": {
"description": "Virtual network does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a Swift Virtual Network connection.",
"operationId": "WebApps_GetSwiftVirtualNetworkConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a Swift Virtual Network connection.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
"operationId": "WebApps_UpdateSwiftVirtualNetworkConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Properties of the Virtual Network connection. See example.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
"operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Properties of the Virtual Network connection. See example.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": {
"get": {
"description": "Description for Gets all network features used by the app (or deployment slot, if specified).",
"operationId": "WebApps_ListNetworkFeatures",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The type of view. This can either be \"summary\" or \"detailed\".",
"in": "path",
"name": "view",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/NetworkFeatures"
}
},
"404": {
"description": "The requested view does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets all network features used by the app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}": {
"get": {
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"operationId": "WebApps_GetNetworkTraceOperation",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "GUID of the operation.",
"in": "path",
"name": "operationId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get the current status of a network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
},
"202": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {
"azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d",
"location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": {
"post": {
"description": "Description for Start capturing network packets for the site (To be deprecated).",
"operationId": "WebApps_StartWebSiteNetworkTrace",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The duration to keep capturing in seconds.",
"format": "int32",
"in": "query",
"name": "durationInSeconds",
"type": "integer"
},
{
"description": "The maximum frame length in bytes (Optional).",
"format": "int32",
"in": "query",
"name": "maxFrameLength",
"type": "integer"
},
{
"description": "The Blob URL to store capture file.",
"in": "query",
"name": "sasUrl",
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Start capturing network packets for the site (To be deprecated).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": {
"post": {
"description": "Description for Start capturing network packets for the site.",
"operationId": "WebApps_StartWebSiteNetworkTraceOperation",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The duration to keep capturing in seconds.",
"format": "int32",
"in": "query",
"name": "durationInSeconds",
"type": "integer"
},
{
"description": "The maximum frame length in bytes (Optional).",
"format": "int32",
"in": "query",
"name": "maxFrameLength",
"type": "integer"
},
{
"description": "The Blob URL to store capture file.",
"in": "query",
"name": "sasUrl",
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Start capturing network packets for the site.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Start a new network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"durationInSeconds": 60,
"name": "SampleApp",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
},
"202": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {
"azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d",
"location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": {
"post": {
"description": "Description for Stop ongoing capturing network packets for the site.",
"operationId": "WebApps_StopWebSiteNetworkTrace",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Stopped."
},
"204": {
"description": "Stopped."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Stop ongoing capturing network packets for the site.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Stop a currently running network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {},
"204": {}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}": {
"get": {
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"operationId": "WebApps_GetNetworkTraces",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "GUID of the operation.",
"in": "path",
"name": "operationId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get NetworkTraces for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": {
"get": {
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"operationId": "WebApps_GetNetworkTraceOperationV2",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "GUID of the operation.",
"in": "path",
"name": "operationId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get the current status of a network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
},
"202": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {
"azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d",
"location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": {
"get": {
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"operationId": "WebApps_GetNetworkTracesV2",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "GUID of the operation.",
"in": "path",
"name": "operationId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get NetworkTraces for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": {
"post": {
"description": "Description for Generates a new publishing password for an app (or deployment slot, if specified).",
"operationId": "WebApps_GenerateNewSitePublishingPassword",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully generate new password."
},
"204": {
"description": "Successfully generate new password."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Generates a new publishing password for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": {
"get": {
"description": "Description for Gets perfmon counters for web app.",
"operationId": "WebApps_ListPerfMonCounters",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
"in": "query",
"name": "$filter",
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PerfMonCounterCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets perfmon counters for web app.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": {
"get": {
"description": "Description for Gets web app's event logs.",
"operationId": "WebApps_GetSitePhpErrorLogFlag",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SitePhpErrorLogFlag"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets web app's event logs.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": {
"get": {
"description": "Description for Gets the premier add-ons of an app.",
"operationId": "WebApps_ListPremierAddOns",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the premier add-ons of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": {
"delete": {
"description": "Description for Delete a premier add-on from an app.",
"operationId": "WebApps_DeletePremierAddOn",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Add-on name.",
"in": "path",
"name": "premierAddOnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted premier add-on."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a premier add-on from an app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a named add-on of an app.",
"operationId": "WebApps_GetPremierAddOn",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Add-on name.",
"in": "path",
"name": "premierAddOnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named add-on of an app.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Updates a named add-on of an app.",
"operationId": "WebApps_UpdatePremierAddOn",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Add-on name.",
"in": "path",
"name": "premierAddOnName",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the edited premier add-on.",
"in": "body",
"name": "premierAddOn",
"required": true,
"schema": {
"$ref": "#/definitions/PremierAddOnPatchResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates a named add-on of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates a named add-on of an app.",
"operationId": "WebApps_AddPremierAddOn",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Add-on name.",
"in": "path",
"name": "premierAddOnName",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the edited premier add-on.",
"in": "body",
"name": "premierAddOn",
"required": true,
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates a named add-on of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": {
"get": {
"description": "Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
"operationId": "WebApps_GetPrivateAccess",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
"operationId": "WebApps_PutPrivateAccessVnet",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The information for the private access",
"in": "body",
"name": "access",
"required": true,
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": {
"get": {
"description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListProcesses",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Process terminated.",
"schema": {
"$ref": "#/definitions/ProcessInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": {
"delete": {
"description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"operationId": "WebApps_DeleteProcess",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Process terminated."
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetProcess",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Process information returned.",
"schema": {
"$ref": "#/definitions/ProcessInfo"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": {
"get": {
"description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetProcessDump",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": {
"get": {
"description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListProcessModules",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Module information returned.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}": {
"get": {
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetProcessModule",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Module base address.",
"in": "path",
"name": "baseAddress",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Module information returned.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"404": {
"description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": {
"get": {
"description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListProcessThreads",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Thread information returned.",
"schema": {
"$ref": "#/definitions/ProcessThreadInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": {
"get": {
"description": "Description for Get public certificates for an app or a deployment slot.",
"operationId": "WebApps_ListPublicCertificates",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PublicCertificateCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get public certificates for an app or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": {
"delete": {
"description": "Description for Deletes a hostname binding for an app.",
"operationId": "WebApps_DeletePublicCertificate",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Public certificate name.",
"in": "path",
"name": "publicCertificateName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted hostname binding."
},
"204": {
"description": "Hostname binding does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a hostname binding for an app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get the named public certificate for an app (or deployment slot, if specified).",
"operationId": "WebApps_GetPublicCertificate",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Public certificate name.",
"in": "path",
"name": "publicCertificateName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the named public certificate for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a hostname binding for an app.",
"operationId": "WebApps_CreateOrUpdatePublicCertificate",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Public certificate name.",
"in": "path",
"name": "publicCertificateName",
"required": true,
"type": "string"
},
{
"description": "Public certificate details. This is the JSON representation of a PublicCertificate object.",
"in": "body",
"name": "publicCertificate",
"required": true,
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a hostname binding for an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": {
"post": {
"description": "Description for Gets the publishing profile for an app (or deployment slot, if specified).",
"operationId": "WebApps_ListPublishingProfileXmlWithSecrets",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.",
"in": "body",
"name": "publishingProfileOptions",
"required": true,
"schema": {
"$ref": "#/definitions/CsmPublishingProfileOptions"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the publishing profile for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": {
"post": {
"description": "Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
"operationId": "WebApps_ResetProductionSlotConfig",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": {
"post": {
"description": "Description for Restarts an app (or deployment slot, if specified).",
"operationId": "WebApps_Restart",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.",
"in": "query",
"name": "softRestart",
"type": "boolean"
},
{
"description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).",
"in": "query",
"name": "synchronous",
"type": "boolean"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully restarted app."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restarts an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": {
"post": {
"description": "Description for Restores an app from a backup blob in Azure Storage.",
"operationId": "WebApps_RestoreFromBackupBlob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Information on restore request .",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Restore operation started."
},
"202": {
"description": "Restore operation started."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores an app from a backup blob in Azure Storage.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": {
"post": {
"description": "Description for Restores a deleted web app to this web app.",
"operationId": "WebApps_RestoreFromDeletedApp",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Deleted web app restore information.",
"in": "body",
"name": "restoreRequest",
"required": true,
"schema": {
"$ref": "#/definitions/DeletedAppRestoreRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Restore operation started."
},
"202": {
"description": "Restore operation started."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores a deleted web app to this web app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": {
"post": {
"description": "Description for Restores a web app from a snapshot.",
"operationId": "WebApps_RestoreSnapshot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.",
"in": "body",
"name": "restoreRequest",
"required": true,
"schema": {
"$ref": "#/definitions/SnapshotRestoreRequest"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Restore operation started."
},
"202": {
"description": "Restore operation started."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores a web app from a snapshot.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": {
"get": {
"description": "Description for Get list of siteextensions for a web site, or a deployment slot.",
"operationId": "WebApps_ListSiteExtensions",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "SiteExtension information returned.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfoCollection"
}
},
"404": {
"description": "SiteExtension not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get list of siteextensions for a web site, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": {
"delete": {
"description": "Description for Remove a site extension from a web site, or a deployment slot.",
"operationId": "WebApps_DeleteSiteExtension",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Site extension name.",
"in": "path",
"name": "siteExtensionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "SiteExtension terminated."
},
"404": {
"description": "SiteExtension with an ID of {siteExtensionId} is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Remove a site extension from a web site, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get site extension information by its ID for a web site, or a deployment slot.",
"operationId": "WebApps_GetSiteExtension",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Site extension name.",
"in": "path",
"name": "siteExtensionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "SiteExtension information returned.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"404": {
"description": "SiteExtension with an ID of {siteExtensionId} is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get site extension information by its ID for a web site, or a deployment slot.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Install site extension on a web site, or a deployment slot.",
"operationId": "WebApps_InstallSiteExtension",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Site extension name.",
"in": "path",
"name": "siteExtensionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Site Extension created.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"201": {
"description": "Site Extension created.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"429": {
"description": "Site Extension is being installed on another request: Rejecting current request."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Install site extension on a web site, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotcopy": {
"post": {
"description": "Description for Copies a deployment slot to another deployment slot of an app.",
"operationId": "WebApps_CopyProductionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON object that contains the target slot name and site config properties to override the source slot config. See example.",
"in": "body",
"name": "copySlotEntity",
"required": true,
"schema": {
"$ref": "#/definitions/CsmCopySlotEntity"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"202": {
"description": "Operation is in progress."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Copies a deployment slot to another deployment slot of an app.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Copy slot": {
"parameters": {
"api-version": "2019-08-01",
"copySlotEntity": {
"siteConfig": {
"httpLoggingEnabled": true,
"numberOfWorkers": 1
},
"targetSlot": "staging"
},
"name": "tests346",
"resourceGroupName": "testrg123",
"slot": "staging",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"headers": {}
},
"202": {
"headers": {}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": {
"get": {
"description": "Description for Gets an app's deployment slots.",
"operationId": "WebApps_ListSlots",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of App Service apps.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets an app's deployment slots.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": {
"delete": {
"description": "Description for Deletes a web, mobile, or API app, or one of the deployment slots.",
"operationId": "WebApps_DeleteSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app to delete.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot to delete. By default, the API deletes the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "If true, web app metrics are also deleted.",
"in": "query",
"name": "deleteMetrics",
"type": "boolean"
},
{
"description": "Specify true if the App Service plan will be empty after app deletion and you want to delete the empty App Service plan. By default, the empty App Service plan is not deleted.",
"in": "query",
"name": "deleteEmptyServerFarm",
"type": "boolean"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted web app."
},
"204": {
"description": "Successfully deleted web app."
},
"404": {
"description": "Web app not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a web, mobile, or API app, or one of the deployment slots.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets the details of a web, mobile, or API app.",
"operationId": "WebApps_GetSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"404": {
"description": "Not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the details of a web, mobile, or API app.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"operationId": "WebApps_UpdateSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the app properties. See example.",
"in": "body",
"name": "siteEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/SitePatchResource"
}
},
{
"description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"202": {
"description": "Asynchronous operation in progress.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"operationId": "WebApps_CreateOrUpdateSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the app properties. See example.",
"in": "body",
"name": "siteEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"202": {
"description": "Asynchronous operation in progress.",
"schema": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "Site resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": {
"get": {
"description": "Description for Analyze a custom hostname.",
"operationId": "WebApps_AnalyzeCustomHostnameSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Custom hostname.",
"in": "query",
"name": "hostName",
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CustomHostnameAnalysisResult"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Analyze a custom hostname.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": {
"post": {
"description": "Description for Applies the configuration settings from the target slot onto the current slot.",
"operationId": "WebApps_ApplySlotConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON object that contains the target slot name. See example.",
"in": "body",
"name": "slotSwapEntity",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
},
{
"description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Applies the configuration settings from the target slot onto the current slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": {
"post": {
"description": "Description for Creates a backup of an app.",
"operationId": "WebApps_BackupSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Backup configuration. You can use the JSON response from the POST action as input here.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a backup of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": {
"get": {
"description": "Description for Gets existing backups of an app.",
"operationId": "WebApps_ListBackupsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItemCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets existing backups of an app.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": {
"delete": {
"description": "Description for Deletes a backup of an app by its ID.",
"operationId": "WebApps_DeleteBackupSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of the backup.",
"in": "path",
"name": "backupId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted web app backup item."
},
"404": {
"description": "Web app backup item does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a backup of an app by its ID.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a backup of an app by its ID.",
"operationId": "WebApps_GetBackupStatusSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of the backup.",
"in": "path",
"name": "backupId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a backup of an app by its ID.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": {
"post": {
"description": "Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
"operationId": "WebApps_ListBackupStatusSecretsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of backup.",
"in": "path",
"name": "backupId",
"required": true,
"type": "string"
},
{
"description": "Information on backup request.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": {
"post": {
"description": "Description for Restores a specific backup to another app (or deployment slot, if specified).",
"operationId": "WebApps_RestoreSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of the backup.",
"in": "path",
"name": "backupId",
"required": true,
"type": "string"
},
{
"description": "Information on restore request .",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Restore operation started."
},
"202": {
"description": "Restore operation started."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores a specific backup to another app (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": {
"get": {
"description": "Description for List the configurations of an app",
"operationId": "WebApps_ListConfigurationsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResourceCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List the configurations of an app",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": {
"put": {
"description": "Description for Replaces the application settings of an app.",
"operationId": "WebApps_UpdateApplicationSettingsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Application settings of the app.",
"in": "body",
"name": "appSettings",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Replaces the application settings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": {
"post": {
"description": "Description for Gets the application settings of an app.",
"operationId": "WebApps_ListApplicationSettingsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the application settings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": {
"put": {
"description": "Description for Updates the Authentication / Authorization settings associated with web app.",
"operationId": "WebApps_UpdateAuthSettingsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Auth settings associated with web app.",
"in": "body",
"name": "siteAuthSettings",
"required": true,
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the Authentication / Authorization settings associated with web app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": {
"post": {
"description": "Description for Gets the Authentication/Authorization settings of an app.",
"operationId": "WebApps_GetAuthSettingsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the Authentication/Authorization settings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": {
"put": {
"description": "Description for Updates the Azure storage account configurations of an app.",
"operationId": "WebApps_UpdateAzureStorageAccountsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Azure storage accounts of the app.",
"in": "body",
"name": "azureStorageAccounts",
"required": true,
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the Azure storage account configurations of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": {
"post": {
"description": "Description for Gets the Azure storage account configurations of an app.",
"operationId": "WebApps_ListAzureStorageAccountsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the Azure storage account configurations of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": {
"delete": {
"description": "Description for Deletes the backup configuration of an app.",
"operationId": "WebApps_DeleteBackupConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted backup configuration."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes the backup configuration of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the backup configuration of an app.",
"operationId": "WebApps_UpdateBackupConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Edited backup configuration.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the backup configuration of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": {
"post": {
"description": "Description for Gets the backup configuration of an app.",
"operationId": "WebApps_GetBackupConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the backup configuration of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": {
"put": {
"description": "Description for Replaces the connection strings of an app.",
"operationId": "WebApps_UpdateConnectionStringsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Connection strings of the app or deployment slot. See example.",
"in": "body",
"name": "connectionStrings",
"required": true,
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Replaces the connection strings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": {
"post": {
"description": "Description for Gets the connection strings of an app.",
"operationId": "WebApps_ListConnectionStringsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the connection strings of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": {
"get": {
"description": "Description for Gets the logging configuration of an app.",
"operationId": "WebApps_GetDiagnosticLogsConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the logging configuration of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the logging configuration of an app.",
"operationId": "WebApps_UpdateDiagnosticLogsConfigSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.",
"in": "body",
"name": "siteLogsConfig",
"required": true,
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the logging configuration of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": {
"put": {
"description": "Description for Replaces the metadata of an app.",
"operationId": "WebApps_UpdateMetadataSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Edited metadata of the app or deployment slot. See example.",
"in": "body",
"name": "metadata",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Replaces the metadata of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": {
"post": {
"description": "Description for Gets the metadata of an app.",
"operationId": "WebApps_ListMetadataSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the metadata of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": {
"post": {
"description": "Description for Gets the Git/FTP publishing credentials of an app.",
"operationId": "WebApps_ListPublishingCredentialsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "User credentials used for publishing activity.",
"properties": {
"properties": {
"description": "User resource specific properties",
"properties": {
"publishingPassword": {
"description": "Password used for publishing.",
"format": "password",
"type": "string"
},
"publishingPasswordHash": {
"description": "Password hash used for publishing.",
"format": "password",
"type": "string"
},
"publishingPasswordHashSalt": {
"description": "Password hash salt used for publishing.",
"format": "password",
"type": "string"
},
"publishingUserName": {
"description": "Username used for publishing.",
"type": "string"
},
"scmUri": {
"description": "Url of SCM site.",
"type": "string"
}
},
"required": [
"publishingUserName"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the Git/FTP publishing credentials of an app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": {
"put": {
"description": "Description for Updates the Push settings associated with web app.",
"operationId": "WebApps_UpdateSitePushSettingsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Push settings associated with web app.",
"in": "body",
"name": "pushSettings",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the Push settings associated with web app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": {
"post": {
"description": "Description for Gets the Push settings associated with web app.",
"operationId": "WebApps_ListSitePushSettingsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the Push settings associated with web app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": {
"get": {
"description": "Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
"operationId": "WebApps_GetConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Updates the configuration of an app.",
"operationId": "WebApps_UpdateConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON representation of a SiteConfig object. See example.",
"in": "body",
"name": "siteConfig",
"required": true,
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the configuration of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the configuration of an app.",
"operationId": "WebApps_CreateOrUpdateConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON representation of a SiteConfig object. See example.",
"in": "body",
"name": "siteConfig",
"required": true,
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the configuration of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": {
"get": {
"description": "Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
"operationId": "WebApps_ListConfigurationSnapshotInfoSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": {
"get": {
"description": "Description for Gets a snapshot of the configuration of an app at a previous point in time.",
"operationId": "WebApps_GetConfigurationSnapshotSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The ID of the snapshot to read.",
"in": "path",
"name": "snapshotId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a snapshot of the configuration of an app at a previous point in time.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": {
"post": {
"description": "Description for Reverts the configuration of an app to a previous snapshot.",
"operationId": "WebApps_RecoverSiteConfigurationSnapshotSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The ID of the snapshot to read.",
"in": "path",
"name": "snapshotId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Reverts the configuration of an app to a previous snapshot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": {
"post": {
"description": "Description for Gets the last lines of docker logs for the given site",
"operationId": "WebApps_GetWebSiteContainerLogsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"produces": [
"application/octet-stream"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the last lines of docker logs for the given site",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": {
"post": {
"description": "Description for Gets the ZIP archived docker log files for the given site",
"operationId": "WebApps_GetContainerLogsZipSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"produces": [
"application/zip"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the ZIP archived docker log files for the given site",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": {
"get": {
"description": "Description for List continuous web jobs for an app, or a deployment slot.",
"operationId": "WebApps_ListContinuousWebJobsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContinuousWebJobCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List continuous web jobs for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": {
"delete": {
"description": "Description for Delete a continuous web job by its ID for an app, or a deployment slot.",
"operationId": "WebApps_DeleteContinuousWebJobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted continuous web job."
},
"204": {
"description": "Continuous web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a continuous web job by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a continuous web job by its ID for an app, or a deployment slot.",
"operationId": "WebApps_GetContinuousWebJobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job.",
"schema": {
"$ref": "#/definitions/ContinuousWebJob"
}
},
"404": {
"description": "Continuous web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a continuous web job by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": {
"post": {
"description": "Description for Start a continuous web job for an app, or a deployment slot.",
"operationId": "WebApps_StartContinuousWebJobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job."
},
"404": {
"description": "Continuous web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Start a continuous web job for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": {
"post": {
"description": "Description for Stop a continuous web job for an app, or a deployment slot.",
"operationId": "WebApps_StopContinuousWebJobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job."
},
"404": {
"description": "Continuous web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Stop a continuous web job for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": {
"get": {
"description": "Description for List deployments for an app, or a deployment slot.",
"operationId": "WebApps_ListDeploymentsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DeploymentCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List deployments for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": {
"delete": {
"description": "Description for Delete a deployment by its ID for an app, or a deployment slot.",
"operationId": "WebApps_DeleteDeploymentSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Deployment ID.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted deployment."
},
"204": {
"description": "Deployment does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a deployment by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get a deployment by its ID for an app, or a deployment slot.",
"operationId": "WebApps_GetDeploymentSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Deployment ID.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get a deployment by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Create a deployment for an app, or a deployment slot.",
"operationId": "WebApps_CreateDeploymentSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "ID of an existing deployment.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Deployment details.",
"in": "body",
"name": "deployment",
"required": true,
"schema": {
"$ref": "#/definitions/Deployment"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Create a deployment for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": {
"get": {
"description": "Description for List deployment log for specific deployment for an app, or a deployment slot.",
"operationId": "WebApps_ListDeploymentLogSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List deployment log for specific deployment for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": {
"post": {
"description": "Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
"operationId": "WebApps_DiscoverBackupSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": {
"get": {
"description": "Description for Lists ownership identifiers for domain associated with web app.",
"operationId": "WebApps_ListDomainOwnershipIdentifiersSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of identifiers.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Lists ownership identifiers for domain associated with web app.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": {
"delete": {
"description": "Description for Deletes a domain ownership identifier for a web app.",
"operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of domain ownership identifier.",
"in": "path",
"name": "domainOwnershipIdentifierName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted domain ownership identifier."
},
"204": {
"description": "Domain ownership identifier does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a domain ownership identifier for a web app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get domain ownership identifier for web app.",
"operationId": "WebApps_GetDomainOwnershipIdentifierSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of domain ownership identifier.",
"in": "path",
"name": "domainOwnershipIdentifierName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get domain ownership identifier for web app.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"operationId": "WebApps_UpdateDomainOwnershipIdentifierSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of domain ownership identifier.",
"in": "path",
"name": "domainOwnershipIdentifierName",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the domain ownership properties.",
"in": "body",
"name": "domainOwnershipIdentifier",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of domain ownership identifier.",
"in": "path",
"name": "domainOwnershipIdentifierName",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the domain ownership properties.",
"in": "body",
"name": "domainOwnershipIdentifier",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"description": "Identifier resource specific properties",
"properties": {
"id": {
"description": "String representation of the identity.",
"type": "string",
"x-ms-client-name": "value"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": {
"get": {
"description": "Description for Get the status of the last MSDeploy operation.",
"operationId": "WebApps_GetMSDeployStatusSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the status of the last MSDeploy operation.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Invoke the MSDeploy web app extension.",
"operationId": "WebApps_CreateMSDeployOperationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Details of MSDeploy operation",
"in": "body",
"name": "MSDeploy",
"required": true,
"schema": {
"$ref": "#/definitions/MSDeploy"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"201": {
"description": "Deployment is scheduled.",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"409": {
"description": "Another deployment is in progress."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Invoke the MSDeploy web app extension.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": {
"get": {
"description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
"operationId": "WebApps_GetMSDeployLogSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "MSDeploy log returned.",
"schema": {
"$ref": "#/definitions/MSDeployLog"
}
},
"404": {
"description": "MSDeploy log not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the MSDeploy Log for the last MSDeploy operation.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": {
"get": {
"description": "Description for List the functions for a web site, or a deployment slot.",
"operationId": "WebApps_ListInstanceFunctionsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Function information returned.",
"schema": {
"$ref": "#/definitions/FunctionEnvelopeCollection"
}
},
"404": {
"description": "Function with an ID of {functionName} is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List the functions for a web site, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": {
"get": {
"description": "Description for Fetch a short lived token that can be exchanged for a master key.",
"operationId": "WebApps_GetFunctionsAdminTokenSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Fetch a short lived token that can be exchanged for a master key.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": {
"delete": {
"description": "Description for Delete a function for web site, or a deployment slot.",
"operationId": "WebApps_DeleteInstanceFunctionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Function deleted."
},
"404": {
"description": "Function does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a function for web site, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get function information by its ID for web site, or a deployment slot.",
"operationId": "WebApps_GetInstanceFunctionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Function information returned.",
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
"404": {
"description": "Function with a name of {functionName} does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get function information by its ID for web site, or a deployment slot.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Create function for web site, or a deployment slot.",
"operationId": "WebApps_CreateInstanceFunctionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Function details.",
"in": "body",
"name": "function_envelope",
"required": true,
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"201": {
"description": "Function created.",
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Create function for web site, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}": {
"delete": {
"description": "Description for Delete a function secret.",
"operationId": "WebApps_DeleteFunctionSecretSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The name of the function.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "The name of the key.",
"in": "path",
"name": "keyName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Key was deleted."
},
"404": {
"description": "Key was not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a function secret.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Add or update a function secret.",
"operationId": "WebApps_CreateOrUpdateFunctionSecretSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The name of the function.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "The name of the key.",
"in": "path",
"name": "keyName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "The key to create or update",
"in": "body",
"name": "key",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Key was updated.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"201": {
"description": "Key was created.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Add or update a function secret.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys": {
"post": {
"description": "Description for Get function keys for a function in a web site, or a deployment slot.",
"operationId": "WebApps_ListFunctionKeysSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Function keys returned.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get function keys for a function in a web site, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": {
"post": {
"description": "Description for Get function secrets for a function in a web site, or a deployment slot.",
"operationId": "WebApps_ListFunctionSecretsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Function name.",
"in": "path",
"name": "functionName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Function secrets returned.",
"schema": {
"$ref": "#/definitions/FunctionSecrets"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get function secrets for a function in a web site, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys": {
"post": {
"description": "Description for Get host secrets for a function app.",
"operationId": "WebApps_ListHostKeysSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Host secrets returned.",
"schema": {
"$ref": "#/definitions/HostKeys"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get host secrets for a function app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus": {
"post": {
"description": "Description for This is to allow calling via powershell and ARM template.",
"operationId": "WebApps_ListSyncStatusSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "This is to allow calling via powershell and ARM template.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync": {
"post": {
"description": "Description for Syncs function trigger metadata to the management database",
"operationId": "WebApps_SyncFunctionsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Syncs function trigger metadata to the management database",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}": {
"delete": {
"description": "Description for Delete a host level secret.",
"operationId": "WebApps_DeleteHostSecretSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The type of host key.",
"in": "path",
"name": "keyType",
"required": true,
"type": "string"
},
{
"description": "The name of the key.",
"in": "path",
"name": "keyName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Key was deleted."
},
"404": {
"description": "Key was not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a host level secret.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Add or update a host level secret.",
"operationId": "WebApps_CreateOrUpdateHostSecretSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The type of host key.",
"in": "path",
"name": "keyType",
"required": true,
"type": "string"
},
{
"description": "The name of the key.",
"in": "path",
"name": "keyName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "The key to create or update",
"in": "body",
"name": "key",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Key was updated.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"201": {
"description": "Key was created.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Add or update a host level secret.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": {
"get": {
"description": "Description for Get hostname bindings for an app or a deployment slot.",
"operationId": "WebApps_ListHostNameBindingsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/HostNameBindingCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get hostname bindings for an app or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": {
"delete": {
"description": "Description for Deletes a hostname binding for an app.",
"operationId": "WebApps_DeleteHostNameBindingSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Hostname in the hostname binding.",
"in": "path",
"name": "hostName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted hostname binding."
},
"204": {
"description": "Hostname binding does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a hostname binding for an app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get the named hostname binding for an app (or deployment slot, if specified).",
"operationId": "WebApps_GetHostNameBindingSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Hostname in the hostname binding.",
"in": "path",
"name": "hostName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the named hostname binding for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a hostname binding for an app.",
"operationId": "WebApps_CreateOrUpdateHostNameBindingSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Hostname in the hostname binding.",
"in": "path",
"name": "hostName",
"required": true,
"type": "string"
},
{
"description": "Binding details. This is the JSON representation of a HostNameBinding object.",
"in": "body",
"name": "hostNameBinding",
"required": true,
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a hostname binding for an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": {
"delete": {
"description": "Description for Removes a Hybrid Connection from this site.",
"operationId": "WebApps_DeleteHybridConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The namespace for this hybrid connection.",
"in": "path",
"name": "namespaceName",
"required": true,
"type": "string"
},
{
"description": "The relay name for this hybrid connection.",
"in": "path",
"name": "relayName",
"required": true,
"type": "string"
},
{
"description": "The name of the slot for the web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted hybrid connection."
},
"404": {
"description": "Hybrid connection does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Removes a Hybrid Connection from this site.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
"operationId": "WebApps_GetHybridConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The namespace for this hybrid connection.",
"in": "path",
"name": "namespaceName",
"required": true,
"type": "string"
},
{
"description": "The relay name for this hybrid connection.",
"in": "path",
"name": "relayName",
"required": true,
"type": "string"
},
{
"description": "The name of the slot for the web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
"operationId": "WebApps_UpdateHybridConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The namespace for this hybrid connection.",
"in": "path",
"name": "namespaceName",
"required": true,
"type": "string"
},
{
"description": "The relay name for this hybrid connection.",
"in": "path",
"name": "relayName",
"required": true,
"type": "string"
},
{
"description": "The details of the hybrid connection.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "The name of the slot for the web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new Hybrid Connection using a Service Bus relay.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
"operationId": "WebApps_CreateOrUpdateHybridConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The namespace for this hybrid connection.",
"in": "path",
"name": "namespaceName",
"required": true,
"type": "string"
},
{
"description": "The relay name for this hybrid connection.",
"in": "path",
"name": "relayName",
"required": true,
"type": "string"
},
{
"description": "The details of the hybrid connection.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "The name of the slot for the web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new Hybrid Connection using a Service Bus relay.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays": {
"get": {
"description": "Description for Retrieves all Service Bus Hybrid Connections used by this Web App.",
"operationId": "WebApps_ListHybridConnectionsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The name of the slot for the web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": {
"get": {
"description": "Description for Gets hybrid connections configured for an app (or deployment slot, if specified).",
"operationId": "WebApps_ListRelayServiceConnectionsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": {
"delete": {
"description": "Description for Deletes a relay service connection by its name.",
"operationId": "WebApps_DeleteRelayServiceConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the hybrid connection configuration.",
"in": "path",
"name": "entityName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted relay service connection."
},
"404": {
"description": "Relay service connection does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a relay service connection by its name.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a hybrid connection configuration by its name.",
"operationId": "WebApps_GetRelayServiceConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the hybrid connection.",
"in": "path",
"name": "entityName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a hybrid connection configuration by its name.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"operationId": "WebApps_UpdateRelayServiceConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the hybrid connection configuration.",
"in": "path",
"name": "entityName",
"required": true,
"type": "string"
},
{
"description": "Details of the hybrid connection configuration.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"operationId": "WebApps_CreateOrUpdateRelayServiceConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the hybrid connection configuration.",
"in": "path",
"name": "entityName",
"required": true,
"type": "string"
},
{
"description": "Details of the hybrid connection configuration.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": {
"get": {
"description": "Description for Gets all scale-out instances of an app.",
"operationId": "WebApps_ListInstanceIdentifiersSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebAppInstanceCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets all scale-out instances of an app.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}": {
"get": {
"description": "Description for Gets all scale-out instances of an app.",
"operationId": "WebApps_GetInstanceInfoSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebSiteInstanceStatus"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets all scale-out instances of an app.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get site instance info": {
"parameters": {
"api-version": "2019-08-01",
"instanceId": "134987120",
"name": "tests346",
"resourceGroupName": "testrg123",
"slot": "staging",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging/instances/134987120",
"name": "134987120",
"properties": {
"containers": {
"c1": {
"currentTimeStamp": "2013-10-21T13:28:06.419Z"
}
},
"detectorUrl": "testsec579",
"state": "READY",
"statusUrl": "https://sampleurl"
},
"type": "Microsoft.Web/sites/instances"
},
"headers": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy": {
"get": {
"description": "Description for Get the status of the last MSDeploy operation.",
"operationId": "WebApps_GetInstanceMsDeployStatusSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of web app instance.",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the status of the last MSDeploy operation.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Invoke the MSDeploy web app extension.",
"operationId": "WebApps_CreateInstanceMSDeployOperationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of web app instance.",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"description": "Details of MSDeploy operation",
"in": "body",
"name": "MSDeploy",
"required": true,
"schema": {
"$ref": "#/definitions/MSDeploy"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"201": {
"description": "Deployment is scheduled.",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"409": {
"description": "Another deployment is in progress."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Invoke the MSDeploy web app extension.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log": {
"get": {
"description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
"operationId": "WebApps_GetInstanceMSDeployLogSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of web app instance.",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "MSDeploy log returned.",
"schema": {
"$ref": "#/definitions/MSDeployLog"
}
},
"404": {
"description": "MSDeploy log not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the MSDeploy Log for the last MSDeploy operation.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes": {
"get": {
"description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListInstanceProcessesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Process terminated.",
"schema": {
"$ref": "#/definitions/ProcessInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}": {
"delete": {
"description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"operationId": "WebApps_DeleteInstanceProcessSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Process terminated."
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetInstanceProcessSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Process information returned.",
"schema": {
"$ref": "#/definitions/ProcessInfo"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump": {
"get": {
"description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetInstanceProcessDumpSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules": {
"get": {
"description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListInstanceProcessModulesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Module information returned.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": {
"get": {
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetInstanceProcessModuleSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Module base address.",
"in": "path",
"name": "baseAddress",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Module information returned.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"404": {
"description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads": {
"get": {
"description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListInstanceProcessThreadsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"in": "path",
"name": "instanceId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Thread information returned.",
"schema": {
"$ref": "#/definitions/ProcessThreadInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": {
"post": {
"description": "Description for Shows whether an app can be cloned to another resource group or subscription.",
"operationId": "WebApps_IsCloneableSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. By default, this API returns information on the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/SiteCloneability"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Shows whether an app can be cloned to another resource group or subscription.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listbackups": {
"post": {
"description": "Description for Gets existing backups of an app.",
"operationId": "WebApps_ListSiteBackupsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BackupItemCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets existing backups of an app.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"List backups": {
"parameters": {
"api-version": "2019-08-01",
"name": "tests346",
"resourceGroupName": "testrg123",
"slot": "staging",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging",
"name": "tests346/staging",
"properties": {
"blobName": "blob1",
"status": "InProgress",
"storageAccountUrl": "https://blobstorage.windows.net"
},
"type": "Microsoft.Web/sites/slots"
}
]
},
"headers": {}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus": {
"post": {
"description": "Description for This is to allow calling via powershell and ARM template.",
"operationId": "WebApps_ListSyncFunctionTriggersSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FunctionSecrets"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "This is to allow calling via powershell and ARM template.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status": {
"get": {
"description": "Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
"operationId": "WebApps_GetMigrateMySqlStatusSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MigrateMySqlStatus"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork": {
"delete": {
"description": "Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).",
"operationId": "WebApps_DeleteSwiftVirtualNetworkSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted virtual network."
},
"404": {
"description": "Virtual network does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a Swift Virtual Network connection.",
"operationId": "WebApps_GetSwiftVirtualNetworkConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a Swift Virtual Network connection.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
"operationId": "WebApps_UpdateSwiftVirtualNetworkConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Properties of the Virtual Network connection. See example.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
"operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Properties of the Virtual Network connection. See example.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": {
"get": {
"description": "Description for Gets all network features used by the app (or deployment slot, if specified).",
"operationId": "WebApps_ListNetworkFeaturesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The type of view. This can either be \"summary\" or \"detailed\".",
"in": "path",
"name": "view",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/NetworkFeatures"
}
},
"404": {
"description": "The requested view does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets all network features used by the app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}": {
"get": {
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"operationId": "WebApps_GetNetworkTraceOperationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "GUID of the operation.",
"in": "path",
"name": "operationId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get the current status of a network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
},
"202": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {
"azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d",
"location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start": {
"post": {
"description": "Description for Start capturing network packets for the site (To be deprecated).",
"operationId": "WebApps_StartWebSiteNetworkTraceSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The duration to keep capturing in seconds.",
"format": "int32",
"in": "query",
"name": "durationInSeconds",
"type": "integer"
},
{
"description": "The name of the slot for this web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "The maximum frame length in bytes (Optional).",
"format": "int32",
"in": "query",
"name": "maxFrameLength",
"type": "integer"
},
{
"description": "The Blob URL to store capture file.",
"in": "query",
"name": "sasUrl",
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Start capturing network packets for the site (To be deprecated).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation": {
"post": {
"description": "Description for Start capturing network packets for the site.",
"operationId": "WebApps_StartWebSiteNetworkTraceOperationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The duration to keep capturing in seconds.",
"format": "int32",
"in": "query",
"name": "durationInSeconds",
"type": "integer"
},
{
"description": "The name of the slot for this web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "The maximum frame length in bytes (Optional).",
"format": "int32",
"in": "query",
"name": "maxFrameLength",
"type": "integer"
},
{
"description": "The Blob URL to store capture file.",
"in": "query",
"name": "sasUrl",
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Start capturing network packets for the site.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Start a new network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"durationInSeconds": 60,
"name": "SampleApp",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
},
"202": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {
"azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d",
"location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop": {
"post": {
"description": "Description for Stop ongoing capturing network packets for the site.",
"operationId": "WebApps_StopWebSiteNetworkTraceSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The name of the slot for this web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Stopped."
},
"204": {
"description": "Stopped."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Stop ongoing capturing network packets for the site.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Stop a currently running network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {},
"204": {}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}": {
"get": {
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"operationId": "WebApps_GetNetworkTracesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "GUID of the operation.",
"in": "path",
"name": "operationId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get NetworkTraces for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}": {
"get": {
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"operationId": "WebApps_GetNetworkTraceOperationSlotV2",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "GUID of the operation.",
"in": "path",
"name": "operationId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get the current status of a network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
},
"202": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {
"azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d",
"location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}": {
"get": {
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"operationId": "WebApps_GetNetworkTracesSlotV2",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "GUID of the operation.",
"in": "path",
"name": "operationId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Get NetworkTraces for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": {
"post": {
"description": "Description for Generates a new publishing password for an app (or deployment slot, if specified).",
"operationId": "WebApps_GenerateNewSitePublishingPasswordSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully generate new password."
},
"204": {
"description": "Successfully generate new password."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Generates a new publishing password for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters": {
"get": {
"description": "Description for Gets perfmon counters for web app.",
"operationId": "WebApps_ListPerfMonCountersSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
"in": "query",
"name": "$filter",
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PerfMonCounterCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets perfmon counters for web app.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging": {
"get": {
"description": "Description for Gets web app's event logs.",
"operationId": "WebApps_GetSitePhpErrorLogFlagSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SitePhpErrorLogFlag"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets web app's event logs.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": {
"get": {
"description": "Description for Gets the premier add-ons of an app.",
"operationId": "WebApps_ListPremierAddOnsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the premier add-ons of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": {
"delete": {
"description": "Description for Delete a premier add-on from an app.",
"operationId": "WebApps_DeletePremierAddOnSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Add-on name.",
"in": "path",
"name": "premierAddOnName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted premier add-on."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a premier add-on from an app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a named add-on of an app.",
"operationId": "WebApps_GetPremierAddOnSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Add-on name.",
"in": "path",
"name": "premierAddOnName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a named add-on of an app.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Updates a named add-on of an app.",
"operationId": "WebApps_UpdatePremierAddOnSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Add-on name.",
"in": "path",
"name": "premierAddOnName",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the edited premier add-on.",
"in": "body",
"name": "premierAddOn",
"required": true,
"schema": {
"$ref": "#/definitions/PremierAddOnPatchResource"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates a named add-on of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates a named add-on of an app.",
"operationId": "WebApps_AddPremierAddOnSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Add-on name.",
"in": "path",
"name": "premierAddOnName",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of the edited premier add-on.",
"in": "body",
"name": "premierAddOn",
"required": true,
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates a named add-on of an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks": {
"get": {
"description": "Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
"operationId": "WebApps_GetPrivateAccessSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The name of the slot for the web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
"operationId": "WebApps_PutPrivateAccessVnetSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The information for the private access",
"in": "body",
"name": "access",
"required": true,
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
{
"description": "The name of the slot for the web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes": {
"get": {
"description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListProcessesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Process terminated.",
"schema": {
"$ref": "#/definitions/ProcessInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}": {
"delete": {
"description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"operationId": "WebApps_DeleteProcessSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "Process terminated."
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetProcessSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Process information returned.",
"schema": {
"$ref": "#/definitions/ProcessInfo"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump": {
"get": {
"description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetProcessDumpSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules": {
"get": {
"description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListProcessModulesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Module information returned.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}": {
"get": {
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_GetProcessModuleSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Module base address.",
"in": "path",
"name": "baseAddress",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Module information returned.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"404": {
"description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads": {
"get": {
"description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"operationId": "WebApps_ListProcessThreadsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "PID.",
"in": "path",
"name": "processId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Thread information returned.",
"schema": {
"$ref": "#/definitions/ProcessThreadInfoCollection"
}
},
"404": {
"description": "Process with the specified ID is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates": {
"get": {
"description": "Description for Get public certificates for an app or a deployment slot.",
"operationId": "WebApps_ListPublicCertificatesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PublicCertificateCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get public certificates for an app or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}": {
"delete": {
"description": "Description for Deletes a hostname binding for an app.",
"operationId": "WebApps_DeletePublicCertificateSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Public certificate name.",
"in": "path",
"name": "publicCertificateName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted hostname binding."
},
"204": {
"description": "Hostname binding does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a hostname binding for an app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get the named public certificate for an app (or deployment slot, if specified).",
"operationId": "WebApps_GetPublicCertificateSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Public certificate name.",
"in": "path",
"name": "publicCertificateName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the named public certificate for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Creates a hostname binding for an app.",
"operationId": "WebApps_CreateOrUpdatePublicCertificateSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Public certificate name.",
"in": "path",
"name": "publicCertificateName",
"required": true,
"type": "string"
},
{
"description": "Public certificate details. This is the JSON representation of a PublicCertificate object.",
"in": "body",
"name": "publicCertificate",
"required": true,
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Creates a hostname binding for an app.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": {
"post": {
"description": "Description for Gets the publishing profile for an app (or deployment slot, if specified).",
"operationId": "WebApps_ListPublishingProfileXmlWithSecretsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.",
"in": "body",
"name": "publishingProfileOptions",
"required": true,
"schema": {
"$ref": "#/definitions/CsmPublishingProfileOptions"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the publishing profile for an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": {
"post": {
"description": "Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
"operationId": "WebApps_ResetSlotConfigurationSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": {
"post": {
"description": "Description for Restarts an app (or deployment slot, if specified).",
"operationId": "WebApps_RestartSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will restart the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.",
"in": "query",
"name": "softRestart",
"type": "boolean"
},
{
"description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).",
"in": "query",
"name": "synchronous",
"type": "boolean"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully restarted app."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restarts an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob": {
"post": {
"description": "Description for Restores an app from a backup blob in Azure Storage.",
"operationId": "WebApps_RestoreFromBackupBlobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Information on restore request .",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Restore operation started."
},
"202": {
"description": "Restore operation started."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores an app from a backup blob in Azure Storage.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp": {
"post": {
"description": "Description for Restores a deleted web app to this web app.",
"operationId": "WebApps_RestoreFromDeletedAppSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Deleted web app restore information.",
"in": "body",
"name": "restoreRequest",
"required": true,
"schema": {
"$ref": "#/definitions/DeletedAppRestoreRequest"
}
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Restore operation started."
},
"202": {
"description": "Restore operation started."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores a deleted web app to this web app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot": {
"post": {
"description": "Description for Restores a web app from a snapshot.",
"operationId": "WebApps_RestoreSnapshotSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.",
"in": "body",
"name": "restoreRequest",
"required": true,
"schema": {
"$ref": "#/definitions/SnapshotRestoreRequest"
}
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Restore operation started."
},
"202": {
"description": "Restore operation started."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Restores a web app from a snapshot.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions": {
"get": {
"description": "Description for Get list of siteextensions for a web site, or a deployment slot.",
"operationId": "WebApps_ListSiteExtensionsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "SiteExtension information returned.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfoCollection"
}
},
"404": {
"description": "SiteExtension not found."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get list of siteextensions for a web site, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}": {
"delete": {
"description": "Description for Remove a site extension from a web site, or a deployment slot.",
"operationId": "WebApps_DeleteSiteExtensionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Site extension name.",
"in": "path",
"name": "siteExtensionId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "SiteExtension terminated."
},
"404": {
"description": "SiteExtension with an ID of {siteExtensionId} is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Remove a site extension from a web site, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Get site extension information by its ID for a web site, or a deployment slot.",
"operationId": "WebApps_GetSiteExtensionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Site extension name.",
"in": "path",
"name": "siteExtensionId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "SiteExtension information returned.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"404": {
"description": "SiteExtension with an ID of {siteExtensionId} is not running."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get site extension information by its ID for a web site, or a deployment slot.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Install site extension on a web site, or a deployment slot.",
"operationId": "WebApps_InstallSiteExtensionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Site extension name.",
"in": "path",
"name": "siteExtensionId",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Site Extension created.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"201": {
"description": "Site Extension created.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"429": {
"description": "Site Extension is being installed on another request: Rejecting current request."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Install site extension on a web site, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotcopy": {
"post": {
"description": "Description for Copies a deployment slot to another deployment slot of an app.",
"operationId": "WebApps_CopySlotSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON object that contains the target slot name and site config properties to override the source slot config. See example.",
"in": "body",
"name": "copySlotEntity",
"required": true,
"schema": {
"$ref": "#/definitions/CsmCopySlotEntity"
}
},
{
"description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"202": {
"description": "Operation is in progress."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Copies a deployment slot to another deployment slot of an app.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Copy slot": {
"parameters": {
"api-version": "2019-08-01",
"copySlotEntity": {
"siteConfig": {
"httpLoggingEnabled": true,
"numberOfWorkers": 1
},
"targetSlot": "staging"
},
"name": "tests346",
"resourceGroupName": "testrg123",
"slot": "staging",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"headers": {}
},
"202": {
"headers": {}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs": {
"post": {
"description": "Description for Get the difference in configuration settings between two web app slots.",
"operationId": "WebApps_ListSlotDifferencesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON object that contains the target slot name. See example.",
"in": "body",
"name": "slotSwapEntity",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
},
{
"description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SlotDifferenceCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the difference in configuration settings between two web app slots.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": {
"post": {
"description": "Description for Swaps two deployment slots of an app.",
"operationId": "WebApps_SwapSlotSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON object that contains the target slot name. See example.",
"in": "body",
"name": "slotSwapEntity",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
},
{
"description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"202": {
"description": "Operation is in progress."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Swaps two deployment slots of an app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots": {
"get": {
"description": "Description for Returns all Snapshots to the user.",
"operationId": "WebApps_ListSnapshotsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Website Name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Website Slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SnapshotCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Returns all Snapshots to the user.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr": {
"get": {
"description": "Description for Returns all Snapshots to the user from DRSecondary endpoint.",
"operationId": "WebApps_ListSnapshotsFromDRSecondarySlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Website Name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Website Slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SnapshotCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Returns all Snapshots to the user from DRSecondary endpoint.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": {
"delete": {
"description": "Description for Deletes the source control configuration of an app.",
"operationId": "WebApps_DeleteSourceControlSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the source control configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted source control for web app."
},
"202": {
"description": "Source control delete operation in progress."
},
"404": {
"description": "Source control does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes the source control configuration of an app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets the source control configuration of an app.",
"operationId": "WebApps_GetSourceControlSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved source control for web app.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Create or update source control for web app still in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "Create or update source control for web app still in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the source control configuration of an app.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Updates the source control configuration of an app.",
"operationId": "WebApps_UpdateSourceControlSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON representation of a SiteSourceControl object. See example.",
"in": "body",
"name": "siteSourceControl",
"required": true,
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully created or updated source control for web app.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Create or update source control for web app in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "Create or update source control for web app in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the source control configuration of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the source control configuration of an app.",
"operationId": "WebApps_CreateOrUpdateSourceControlSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON representation of a SiteSourceControl object. See example.",
"in": "body",
"name": "siteSourceControl",
"required": true,
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully created or updated source control for web app.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Create or update source control for web app in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "Create or update source control for web app in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the source control configuration of an app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": {
"post": {
"description": "Description for Starts an app (or deployment slot, if specified).",
"operationId": "WebApps_StartSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will start the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully started app."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Starts an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace": {
"post": {
"description": "Description for Start capturing network packets for the site.",
"operationId": "WebApps_StartNetworkTraceSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The duration to keep capturing in seconds.",
"format": "int32",
"in": "query",
"name": "durationInSeconds",
"type": "integer"
},
{
"description": "The name of the slot for this web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "The maximum frame length in bytes (Optional).",
"format": "int32",
"in": "query",
"name": "maxFrameLength",
"type": "integer"
},
{
"description": "The Blob URL to store capture file.",
"in": "query",
"name": "sasUrl",
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Start capturing network packets for the site.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Start a new network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"durationInSeconds": 60,
"name": "SampleApp",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
},
"202": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {
"azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d",
"location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": {
"post": {
"description": "Description for Stops an app (or deployment slot, if specified).",
"operationId": "WebApps_StopSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will stop the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully stopped app."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Stops an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace": {
"post": {
"description": "Description for Stop ongoing capturing network packets for the site.",
"operationId": "WebApps_StopNetworkTraceSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The name of the slot for this web app.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Stopped."
},
"204": {
"description": "Stopped."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Stop ongoing capturing network packets for the site.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Stop a currently running network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {},
"204": {}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": {
"post": {
"description": "Description for Sync web app repository.",
"operationId": "WebApps_SyncRepositorySlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of web app slot. If not specified then will default to production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully sync source control."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Sync web app repository.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers": {
"post": {
"description": "Description for Syncs function trigger metadata to the management database",
"operationId": "WebApps_SyncFunctionTriggersSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Syncs function trigger metadata to the management database",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs": {
"get": {
"description": "Description for List triggered web jobs for an app, or a deployment slot.",
"operationId": "WebApps_ListTriggeredWebJobsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TriggeredWebJobCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List triggered web jobs for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}": {
"delete": {
"description": "Description for Delete a triggered web job by its ID for an app, or a deployment slot.",
"operationId": "WebApps_DeleteTriggeredWebJobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API deletes web job for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted continuous web job."
},
"204": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a triggered web job by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a triggered web job by its ID for an app, or a deployment slot.",
"operationId": "WebApps_GetTriggeredWebJobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job.",
"schema": {
"$ref": "#/definitions/TriggeredWebJob"
}
},
"404": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a triggered web job by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history": {
"get": {
"description": "Description for List a triggered web job's history for an app, or a deployment slot.",
"operationId": "WebApps_ListTriggeredWebJobHistorySlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job.",
"schema": {
"$ref": "#/definitions/TriggeredJobHistoryCollection"
}
},
"404": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List a triggered web job's history for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}": {
"get": {
"description": "Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
"operationId": "WebApps_GetTriggeredWebJobHistorySlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "History ID.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job.",
"schema": {
"$ref": "#/definitions/TriggeredJobHistory"
}
},
"404": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run": {
"post": {
"description": "Description for Run a triggered web job for an app, or a deployment slot.",
"operationId": "WebApps_RunTriggeredWebJobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Run a triggered web job."
},
"404": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Run a triggered web job for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": {
"get": {
"description": "Description for Gets the quota usage information of an app (or deployment slot, if specified).",
"operationId": "WebApps_ListUsagesSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
"in": "query",
"name": "$filter",
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of CSM usage quotas.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"description": "Usage of the quota resource.",
"properties": {
"currentValue": {
"description": "The current value of the resource counter.",
"format": "int64",
"type": "integer"
},
"limit": {
"description": "The resource limit.",
"format": "int64",
"type": "integer"
},
"name": {
"description": "Localizable string object containing the name and a localized value.",
"properties": {
"localizedValue": {
"description": "Localized name.",
"type": "string"
},
"value": {
"description": "Non-localized name.",
"type": "string"
}
},
"type": "object"
},
"nextResetTime": {
"description": "Next reset time for the resource counter.",
"format": "date-time",
"type": "string"
},
"unit": {
"description": "Units of measurement for the quota resource.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the quota usage information of an app (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": {
"get": {
"description": "Description for Gets the virtual networks the app (or deployment slot) is connected to.",
"operationId": "WebApps_ListVnetConnectionsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the virtual networks the app (or deployment slot) is connected to.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": {
"delete": {
"description": "Description for Deletes a connection from an app (or deployment slot to a named virtual network.",
"operationId": "WebApps_DeleteVnetConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the virtual network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted virtual network."
},
"404": {
"description": "Virtual network does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a connection from an app (or deployment slot to a named virtual network.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a virtual network the app (or deployment slot) is connected to by name.",
"operationId": "WebApps_GetVnetConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the virtual network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a virtual network the app (or deployment slot) is connected to by name.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"operationId": "WebApps_UpdateVnetConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of an existing Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Properties of the Virtual Network connection. See example.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"operationId": "WebApps_CreateOrUpdateVnetConnectionSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of an existing Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Properties of the Virtual Network connection. See example.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": {
"get": {
"description": "Description for Gets an app's Virtual Network gateway.",
"operationId": "WebApps_GetVnetConnectionGatewaySlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"404": {
"description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets an app's Virtual Network gateway.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"operationId": "WebApps_UpdateVnetConnectionGatewaySlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The properties to update this gateway with.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"operationId": "WebApps_CreateOrUpdateVnetConnectionGatewaySlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The properties to update this gateway with.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs": {
"get": {
"description": "Description for List webjobs for an app, or a deployment slot.",
"operationId": "WebApps_ListWebJobsSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebJobCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List webjobs for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}": {
"get": {
"description": "Description for Get webjob information for an app, or a deployment slot.",
"operationId": "WebApps_GetWebJobSlot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the web job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"in": "path",
"name": "slot",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebJob"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get webjob information for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs": {
"post": {
"description": "Description for Get the difference in configuration settings between two web app slots.",
"operationId": "WebApps_ListSlotDifferencesFromProduction",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON object that contains the target slot name. See example.",
"in": "body",
"name": "slotSwapEntity",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SlotDifferenceCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get the difference in configuration settings between two web app slots.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap": {
"post": {
"description": "Description for Swaps two deployment slots of an app.",
"operationId": "WebApps_SwapSlotWithProduction",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON object that contains the target slot name. See example.",
"in": "body",
"name": "slotSwapEntity",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK."
},
"202": {
"description": "Operation is in progress."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Swaps two deployment slots of an app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots": {
"get": {
"description": "Description for Returns all Snapshots to the user.",
"operationId": "WebApps_ListSnapshots",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Website Name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SnapshotCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Returns all Snapshots to the user.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr": {
"get": {
"description": "Description for Returns all Snapshots to the user from DRSecondary endpoint.",
"operationId": "WebApps_ListSnapshotsFromDRSecondary",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Website Name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SnapshotCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Returns all Snapshots to the user from DRSecondary endpoint.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": {
"delete": {
"description": "Description for Deletes the source control configuration of an app.",
"operationId": "WebApps_DeleteSourceControl",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted source control for web app."
},
"202": {
"description": "Source control delete operation in progress."
},
"404": {
"description": "Source control does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes the source control configuration of an app.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets the source control configuration of an app.",
"operationId": "WebApps_GetSourceControl",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved source control for web app.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Create or update source control for web app still in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "Create or update source control for web app still in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the source control configuration of an app.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Updates the source control configuration of an app.",
"operationId": "WebApps_UpdateSourceControl",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON representation of a SiteSourceControl object. See example.",
"in": "body",
"name": "siteSourceControl",
"required": true,
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully created or updated source control for web app.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Create or update source control for web app in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "Create or update source control for web app in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the source control configuration of an app.",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Updates the source control configuration of an app.",
"operationId": "WebApps_CreateOrUpdateSourceControl",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "JSON representation of a SiteSourceControl object. See example.",
"in": "body",
"name": "siteSourceControl",
"required": true,
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully created or updated source control for web app.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Create or update source control for web app in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "Create or update source control for web app in progress.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Updates the source control configuration of an app.",
"tags": [
"WebApps"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": {
"post": {
"description": "Description for Starts an app (or deployment slot, if specified).",
"operationId": "WebApps_Start",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully started app."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Starts an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace": {
"post": {
"description": "Description for Start capturing network packets for the site.",
"operationId": "WebApps_StartNetworkTrace",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "The duration to keep capturing in seconds.",
"format": "int32",
"in": "query",
"name": "durationInSeconds",
"type": "integer"
},
{
"description": "The maximum frame length in bytes (Optional).",
"format": "int32",
"in": "query",
"name": "maxFrameLength",
"type": "integer"
},
{
"description": "The Blob URL to store capture file.",
"in": "query",
"name": "sasUrl",
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"items": {
"$ref": "#/definitions/NetworkTrace"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Start capturing network packets for the site.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Start a new network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"durationInSeconds": 60,
"name": "SampleApp",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {}
},
"202": {
"body": [
{
"message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
"status": "Succeeded"
}
],
"headers": {
"azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d",
"location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": {
"post": {
"description": "Description for Stops an app (or deployment slot, if specified).",
"operationId": "WebApps_Stop",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully stopped app."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Stops an app (or deployment slot, if specified).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace": {
"post": {
"description": "Description for Stop ongoing capturing network packets for the site.",
"operationId": "WebApps_StopNetworkTrace",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "The name of the web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Stopped."
},
"204": {
"description": "Stopped."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Stop ongoing capturing network packets for the site.",
"tags": [
"WebApps"
],
"x-ms-examples": {
"Stop a currently running network trace operation for a site": {
"parameters": {
"api-version": "2019-08-01",
"name": "SampleApp",
"resourceGroupName": "testrg123",
"slot": "Production",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {},
"204": {}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": {
"post": {
"description": "Description for Sync web app repository.",
"operationId": "WebApps_SyncRepository",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of web app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully sync source control."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Sync web app repository.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers": {
"post": {
"description": "Description for Syncs function trigger metadata to the management database",
"operationId": "WebApps_SyncFunctionTriggers",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Syncs function trigger metadata to the management database",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs": {
"get": {
"description": "Description for List triggered web jobs for an app, or a deployment slot.",
"operationId": "WebApps_ListTriggeredWebJobs",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TriggeredWebJobCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List triggered web jobs for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}": {
"delete": {
"description": "Description for Delete a triggered web job by its ID for an app, or a deployment slot.",
"operationId": "WebApps_DeleteTriggeredWebJob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted continuous web job."
},
"204": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Delete a triggered web job by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a triggered web job by its ID for an app, or a deployment slot.",
"operationId": "WebApps_GetTriggeredWebJob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job.",
"schema": {
"$ref": "#/definitions/TriggeredWebJob"
}
},
"404": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a triggered web job by its ID for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history": {
"get": {
"description": "Description for List a triggered web job's history for an app, or a deployment slot.",
"operationId": "WebApps_ListTriggeredWebJobHistory",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job.",
"schema": {
"$ref": "#/definitions/TriggeredJobHistoryCollection"
}
},
"404": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List a triggered web job's history for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}": {
"get": {
"description": "Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
"operationId": "WebApps_GetTriggeredWebJobHistory",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"description": "History ID.",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Found continuous web job.",
"schema": {
"$ref": "#/definitions/TriggeredJobHistory"
}
},
"404": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run": {
"post": {
"description": "Description for Run a triggered web job for an app, or a deployment slot.",
"operationId": "WebApps_RunTriggeredWebJob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of Web Job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Run a triggered web job."
},
"404": {
"description": "Triggered web job does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Run a triggered web job for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": {
"get": {
"description": "Description for Gets the quota usage information of an app (or deployment slot, if specified).",
"operationId": "WebApps_ListUsages",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
"in": "query",
"name": "$filter",
"type": "string",
"x-ms-skip-url-encoding": true
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of CSM usage quotas.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"description": "Usage of the quota resource.",
"properties": {
"currentValue": {
"description": "The current value of the resource counter.",
"format": "int64",
"type": "integer"
},
"limit": {
"description": "The resource limit.",
"format": "int64",
"type": "integer"
},
"name": {
"description": "Localizable string object containing the name and a localized value.",
"properties": {
"localizedValue": {
"description": "Localized name.",
"type": "string"
},
"value": {
"description": "Non-localized name.",
"type": "string"
}
},
"type": "object"
},
"nextResetTime": {
"description": "Next reset time for the resource counter.",
"format": "date-time",
"type": "string"
},
"unit": {
"description": "Units of measurement for the quota resource.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the quota usage information of an app (or deployment slot, if specified).",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": {
"get": {
"description": "Description for Gets the virtual networks the app (or deployment slot) is connected to.",
"operationId": "WebApps_ListVnetConnections",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"type": "array"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets the virtual networks the app (or deployment slot) is connected to.",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": {
"delete": {
"description": "Description for Deletes a connection from an app (or deployment slot to a named virtual network.",
"operationId": "WebApps_DeleteVnetConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the virtual network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted virtual network."
},
"404": {
"description": "Virtual network does not exist."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Deletes a connection from an app (or deployment slot to a named virtual network.",
"tags": [
"WebApps"
]
},
"get": {
"description": "Description for Gets a virtual network the app (or deployment slot) is connected to by name.",
"operationId": "WebApps_GetVnetConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the virtual network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets a virtual network the app (or deployment slot) is connected to by name.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"operationId": "WebApps_UpdateVnetConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of an existing Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Properties of the Virtual Network connection. See example.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"operationId": "WebApps_CreateOrUpdateVnetConnection",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of an existing Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Properties of the Virtual Network connection. See example.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": {
"get": {
"description": "Description for Gets an app's Virtual Network gateway.",
"operationId": "WebApps_GetVnetConnectionGateway",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"404": {
"description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently."
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Gets an app's Virtual Network gateway.",
"tags": [
"WebApps"
]
},
"patch": {
"description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"operationId": "WebApps_UpdateVnetConnectionGateway",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The properties to update this gateway with.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"tags": [
"WebApps"
]
},
"put": {
"description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"operationId": "WebApps_CreateOrUpdateVnetConnectionGateway",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the app.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the Virtual Network.",
"in": "path",
"name": "vnetName",
"required": true,
"type": "string"
},
{
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The properties to update this gateway with.",
"in": "body",
"name": "connectionEnvelope",
"required": true,
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"description": "The Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"vpnPackageUri": {
"description": "The URI where the VPN package can be downloaded.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
]
}
},
"required": [
"vpnPackageUri"
],
"x-ms-client-flatten": true
}
},
"type": "object"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"tags": [
"WebApps"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs": {
"get": {
"description": "Description for List webjobs for an app, or a deployment slot.",
"operationId": "WebApps_ListWebJobs",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebJobCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "List webjobs for an app, or a deployment slot.",
"tags": [
"WebApps"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}": {
"get": {
"description": "Description for Get webjob information for an app, or a deployment slot.",
"operationId": "WebApps_GetWebJob",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Site name.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the web job.",
"in": "path",
"name": "webJobName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebJob"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
}
},
"summary": "Get webjob information for an app, or a deployment slot.",
"tags": [
"WebApps"
]
}
}
},
"definitions": {
"ApiKVReference": {
"description": "Description of site key vault references.",
"properties": {
"details": {
"type": "string"
},
"identityType": {
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"location": {
"enum": [
"ApplicationSetting"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConfigReferenceLocation"
}
},
"reference": {
"type": "string"
},
"secretName": {
"type": "string"
},
"secretVersion": {
"type": "string"
},
"source": {
"enum": [
"KeyVault"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConfigReferenceSource"
}
},
"status": {
"enum": [
"Initialized",
"Resolved",
"InvalidSyntax",
"MSINotEnabled",
"VaultNotFound",
"SecretNotFound",
"SecretVersionNotFound",
"AccessToKeyVaultDenied",
"OtherReasons"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ResolveStatus"
}
},
"vaultName": {
"type": "string"
}
},
"type": "object"
},
"ApplicationLogsConfig": {
"description": "Application logs configuration.",
"properties": {
"azureBlobStorage": {
"$ref": "#/definitions/AzureBlobStorageApplicationLogsConfig",
"description": "Application logs to blob storage configuration."
},
"azureTableStorage": {
"$ref": "#/definitions/AzureTableStorageApplicationLogsConfig",
"description": "Application logs to azure table storage configuration."
},
"fileSystem": {
"$ref": "#/definitions/FileSystemApplicationLogsConfig",
"description": "Application logs to file system configuration."
}
},
"type": "object"
},
"AzureBlobStorageApplicationLogsConfig": {
"description": "Application logs azure blob storage configuration.",
"properties": {
"level": {
"description": "Log level.",
"enum": [
"Off",
"Verbose",
"Information",
"Warning",
"Error"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "LogLevel"
}
},
"retentionInDays": {
"description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention.",
"format": "int32",
"type": "integer"
},
"sasUrl": {
"description": "SAS url to a azure blob container with read/write/list/delete permissions.",
"type": "string"
}
},
"type": "object"
},
"AzureBlobStorageHttpLogsConfig": {
"description": "Http logs to azure blob storage configuration.",
"properties": {
"enabled": {
"description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.",
"type": "boolean"
},
"retentionInDays": {
"description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention.",
"format": "int32",
"type": "integer"
},
"sasUrl": {
"description": "SAS url to a azure blob container with read/write/list/delete permissions.",
"type": "string"
}
},
"type": "object"
},
"AzureStorageInfoValue": {
"description": "Azure Files or Blob Storage access information value for dictionary storage.",
"properties": {
"accessKey": {
"description": "Access key for the storage account.",
"type": "string"
},
"accountName": {
"description": "Name of the storage account.",
"type": "string"
},
"mountPath": {
"description": "Path to mount the storage within the site's runtime environment.",
"type": "string"
},
"shareName": {
"description": "Name of the file share (container name, for Blob storage).",
"type": "string"
},
"state": {
"description": "State of the storage account.",
"enum": [
"Ok",
"InvalidCredentials",
"InvalidShare"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AzureStorageState"
}
},
"type": {
"description": "Type of storage.",
"enum": [
"AzureFiles",
"AzureBlob"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AzureStorageType"
}
}
},
"type": "object"
},
"AzureStoragePropertyDictionaryResource": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "AzureStorageInfo dictionary resource.",
"properties": {
"properties": {
"additionalProperties": {
"$ref": "#/definitions/AzureStorageInfoValue"
},
"description": "Azure storage accounts.",
"type": "object",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"AzureTableStorageApplicationLogsConfig": {
"description": "Application logs to Azure table storage configuration.",
"properties": {
"level": {
"description": "Log level.",
"enum": [
"Off",
"Verbose",
"Information",
"Warning",
"Error"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "LogLevel"
}
},
"sasUrl": {
"description": "SAS URL to an Azure table with add/query/delete permissions.",
"type": "string"
}
},
"required": [
"sasUrl"
],
"type": "object"
},
"BackupItem": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Backup description.",
"properties": {
"properties": {
"description": "BackupItem resource specific properties",
"properties": {
"blobName": {
"description": "Name of the blob which contains data for this backup.",
"readOnly": true,
"type": "string"
},
"correlationId": {
"description": "Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "Timestamp of the backup creation.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"databases": {
"description": "List of databases included in the backup.",
"items": {
"$ref": "#/definitions/DatabaseBackupSetting"
},
"readOnly": true,
"type": "array"
},
"finishedTimeStamp": {
"description": "Timestamp when this backup finished.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Id of the backup.",
"format": "int32",
"readOnly": true,
"type": "integer",
"x-ms-client-name": "BackupId"
},
"lastRestoreTimeStamp": {
"description": "Timestamp of a last restore operation which used this backup.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"log": {
"description": "Details regarding this backup. Might contain an error message.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of this backup.",
"readOnly": true,
"type": "string"
},
"scheduled": {
"description": "True if this backup has been created due to a schedule being triggered.",
"readOnly": true,
"type": "boolean"
},
"sizeInBytes": {
"description": "Size of the backup in bytes.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"status": {
"description": "Backup status.",
"enum": [
"InProgress",
"Failed",
"Succeeded",
"TimedOut",
"Created",
"Skipped",
"PartiallySucceeded",
"DeleteInProgress",
"DeleteFailed",
"Deleted"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "BackupItemStatus"
}
},
"storageAccountUrl": {
"description": "SAS URL for the storage account container which contains this backup.",
"readOnly": true,
"type": "string"
},
"websiteSizeInBytes": {
"description": "Size of the original web app which has been backed up.",
"format": "int64",
"readOnly": true,
"type": "integer"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"BackupItemCollection": {
"description": "Collection of backup items.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/BackupItem"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"BackupRequest": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Description of a backup which will be performed.",
"properties": {
"properties": {
"description": "BackupRequest resource specific properties",
"properties": {
"backupName": {
"description": "Name of the backup.",
"type": "string"
},
"backupSchedule": {
"$ref": "#/definitions/BackupSchedule",
"description": "Schedule for the backup if it is executed periodically."
},
"databases": {
"description": "Databases included in the backup.",
"items": {
"$ref": "#/definitions/DatabaseBackupSetting"
},
"type": "array"
},
"enabled": {
"description": "True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.",
"type": "boolean"
},
"storageAccountUrl": {
"description": "SAS URL to the container.",
"type": "string"
}
},
"required": [
"storageAccountUrl"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"BackupSchedule": {
"description": "Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.",
"properties": {
"frequencyInterval": {
"default": 7,
"description": "How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)",
"format": "int32",
"type": "integer"
},
"frequencyUnit": {
"default": "Day",
"description": "The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)",
"enum": [
"Day",
"Hour"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "FrequencyUnit"
}
},
"keepAtLeastOneBackup": {
"default": true,
"description": "True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.",
"type": "boolean"
},
"lastExecutionTime": {
"description": "Last time when this schedule was triggered.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"retentionPeriodInDays": {
"default": 30,
"description": "After how many days backups should be deleted.",
"format": "int32",
"type": "integer"
},
"startTime": {
"description": "When the schedule should start working.",
"format": "date-time",
"type": "string"
}
},
"required": [
"frequencyInterval",
"frequencyUnit",
"keepAtLeastOneBackup",
"retentionPeriodInDays"
],
"type": "object"
},
"ConnStringValueTypePair": {
"description": "Database connection string value to type pair.",
"properties": {
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"required": [
"value",
"type"
],
"type": "object"
},
"ConnectionStringDictionary": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "String dictionary resource.",
"properties": {
"properties": {
"additionalProperties": {
"$ref": "#/definitions/ConnStringValueTypePair"
},
"description": "Connection strings.",
"type": "object",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ContainerCpuStatistics": {
"properties": {
"cpuUsage": {
"$ref": "#/definitions/ContainerCpuUsage"
},
"onlineCpuCount": {
"format": "int32",
"type": "integer"
},
"systemCpuUsage": {
"format": "int64",
"type": "integer"
},
"throttlingData": {
"$ref": "#/definitions/ContainerThrottlingData"
}
},
"type": "object"
},
"ContainerCpuUsage": {
"properties": {
"kernelModeUsage": {
"format": "int64",
"type": "integer"
},
"perCpuUsage": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"totalUsage": {
"format": "int64",
"type": "integer"
},
"userModeUsage": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"ContainerInfo": {
"properties": {
"currentCpuStats": {
"$ref": "#/definitions/ContainerCpuStatistics"
},
"currentTimeStamp": {
"format": "date-time",
"type": "string"
},
"eth0": {
"$ref": "#/definitions/ContainerNetworkInterfaceStatistics"
},
"id": {
"type": "string"
},
"memoryStats": {
"$ref": "#/definitions/ContainerMemoryStatistics"
},
"name": {
"type": "string"
},
"previousCpuStats": {
"$ref": "#/definitions/ContainerCpuStatistics"
},
"previousTimeStamp": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"ContainerMemoryStatistics": {
"properties": {
"limit": {
"format": "int64",
"type": "integer"
},
"maxUsage": {
"format": "int64",
"type": "integer"
},
"usage": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"ContainerNetworkInterfaceStatistics": {
"properties": {
"rxBytes": {
"format": "int64",
"type": "integer"
},
"rxDropped": {
"format": "int64",
"type": "integer"
},
"rxErrors": {
"format": "int64",
"type": "integer"
},
"rxPackets": {
"format": "int64",
"type": "integer"
},
"txBytes": {
"format": "int64",
"type": "integer"
},
"txDropped": {
"format": "int64",
"type": "integer"
},
"txErrors": {
"format": "int64",
"type": "integer"
},
"txPackets": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"ContainerThrottlingData": {
"properties": {
"periods": {
"format": "int32",
"type": "integer"
},
"throttledPeriods": {
"format": "int32",
"type": "integer"
},
"throttledTime": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ContinuousWebJob": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Continuous Web Job Information.",
"properties": {
"properties": {
"description": "ContinuousWebJob resource specific properties",
"properties": {
"detailed_status": {
"description": "Detailed status.",
"type": "string"
},
"error": {
"description": "Error information.",
"type": "string"
},
"extra_info_url": {
"description": "Extra Info URL.",
"type": "string"
},
"log_url": {
"description": "Log URL.",
"type": "string"
},
"run_command": {
"description": "Run command.",
"type": "string"
},
"settings": {
"additionalProperties": {
"type": "object"
},
"description": "Job settings.",
"type": "object"
},
"status": {
"description": "Job status.",
"enum": [
"Initializing",
"Starting",
"Running",
"PendingRestart",
"Stopped"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ContinuousWebJobStatus"
}
},
"url": {
"description": "Job URL.",
"type": "string"
},
"using_sdk": {
"description": "Using SDK?",
"type": "boolean"
},
"web_job_type": {
"description": "Job type.",
"enum": [
"Continuous",
"Triggered"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "WebJobType"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ContinuousWebJobCollection": {
"description": "Collection of Kudu continuous web job information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/ContinuousWebJob"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"CsmCopySlotEntity": {
"description": "Copy deployment slot parameters.",
"properties": {
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"targetSlot": {
"description": "Destination deployment slot during copy operation.",
"type": "string"
}
},
"required": [
"targetSlot",
"siteConfig"
],
"type": "object"
},
"CsmPublishingProfileOptions": {
"description": "Publishing options for requested profile.",
"properties": {
"format": {
"description": "Name of the format. Valid values are: \nFileZilla3\nWebDeploy -- default\nFtp",
"enum": [
"FileZilla3",
"WebDeploy",
"Ftp"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "PublishingProfileFormat"
}
},
"includeDisasterRecoveryEndpoints": {
"description": "Include the DisasterRecover endpoint if true",
"type": "boolean"
}
},
"type": "object"
},
"CsmSlotEntity": {
"description": "Deployment slot parameters.",
"properties": {
"preserveVnet": {
"description": "true to preserve Virtual Network to the slot during swap; otherwise, false.",
"type": "boolean"
},
"targetSlot": {
"description": "Destination deployment slot during swap operation.",
"type": "string"
}
},
"required": [
"targetSlot",
"preserveVnet"
],
"type": "object"
},
"CustomHostnameAnalysisResult": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Custom domain analysis.",
"properties": {
"properties": {
"description": "CustomHostnameAnalysisResult resource specific properties",
"properties": {
"aRecords": {
"description": "A records controller can see for this hostname.",
"items": {
"type": "string"
},
"type": "array"
},
"alternateCNameRecords": {
"description": "Alternate CName records controller can see for this hostname.",
"items": {
"type": "string"
},
"type": "array"
},
"alternateTxtRecords": {
"description": "Alternate TXT records controller can see for this hostname.",
"items": {
"type": "string"
},
"type": "array"
},
"cNameRecords": {
"description": "CName records controller can see for this hostname.",
"items": {
"type": "string"
},
"type": "array"
},
"conflictingAppResourceId": {
"description": "Name of the conflicting app on scale unit if it's within the same subscription.",
"readOnly": true,
"type": "string"
},
"customDomainVerificationFailureInfo": {
"description": "Body of the error response returned from the API.",
"properties": {
"code": {
"description": "Basic error code.",
"type": "string"
},
"extendedCode": {
"description": "Type of error.",
"type": "string"
},
"innerErrors": {
"description": "Inner errors.",
"items": {
"$ref": "#/definitions/ErrorEntity"
},
"type": "array"
},
"message": {
"description": "Any details of the error.",
"type": "string"
},
"messageTemplate": {
"description": "Message template.",
"type": "string"
},
"parameters": {
"description": "Parameters for the template.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"customDomainVerificationTest": {
"description": "DNS verification test result.",
"enum": [
"Passed",
"Failed",
"Skipped"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "DnsVerificationTestResult"
}
},
"hasConflictAcrossSubscription": {
"description": "true if there is a conflict across subscriptions; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"hasConflictOnScaleUnit": {
"description": "true if there is a conflict on a scale unit; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isHostnameAlreadyVerified": {
"description": "true if hostname is already verified; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"txtRecords": {
"description": "TXT records controller can see for this hostname.",
"items": {
"type": "string"
},
"type": "array"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"DatabaseBackupSetting": {
"description": "Database backup settings.",
"properties": {
"connectionString": {
"description": "Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.",
"type": "string"
},
"connectionStringName": {
"description": "Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options.",
"type": "string"
},
"databaseType": {
"description": "Database type (e.g. SqlAzure / MySql).",
"enum": [
"SqlAzure",
"MySql",
"LocalMySql",
"PostgreSql"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "DatabaseType"
}
},
"name": {
"type": "string"
}
},
"required": [
"databaseType"
],
"type": "object"
},
"DeletedAppRestoreRequest": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Details about restoring a deleted app.",
"properties": {
"properties": {
"description": "DeletedAppRestoreRequest resource specific properties",
"properties": {
"deletedSiteId": {
"description": "ARM resource ID of the deleted app. Example:\n/subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}",
"type": "string"
},
"recoverConfiguration": {
"description": "If true, deleted site configuration, in addition to content, will be restored.",
"type": "boolean"
},
"snapshotTime": {
"description": "Point in time to restore the deleted app from, formatted as a DateTime string. \nIf unspecified, default value is the time that the app was deleted.",
"type": "string"
},
"useDRSecondary": {
"description": "If true, the snapshot is retrieved from DRSecondary endpoint.",
"type": "boolean"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"Deployment": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "User credentials used for publishing activity.",
"properties": {
"properties": {
"description": "Deployment resource specific properties",
"properties": {
"active": {
"description": "True if deployment is currently active, false if completed and null if not started.",
"type": "boolean"
},
"author": {
"description": "Who authored the deployment.",
"type": "string"
},
"author_email": {
"description": "Author email.",
"type": "string"
},
"deployer": {
"description": "Who performed the deployment.",
"type": "string"
},
"details": {
"description": "Details on deployment.",
"type": "string"
},
"end_time": {
"description": "End time.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Details about deployment status.",
"type": "string"
},
"start_time": {
"description": "Start time.",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Deployment status.",
"format": "int32",
"type": "integer"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"DeploymentCollection": {
"description": "Collection of app deployments.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/Deployment"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"EnabledConfig": {
"description": "Enabled configuration.",
"properties": {
"enabled": {
"description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.",
"type": "boolean"
}
},
"type": "object"
},
"ErrorEntity": {},
"FileSystemApplicationLogsConfig": {
"description": "Application logs to file system configuration.",
"properties": {
"level": {
"default": "Off",
"description": "Log level.",
"enum": [
"Off",
"Verbose",
"Information",
"Warning",
"Error"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "LogLevel"
}
}
},
"type": "object"
},
"FileSystemHttpLogsConfig": {
"description": "Http logs to file system configuration.",
"properties": {
"enabled": {
"description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.",
"type": "boolean"
},
"retentionInDays": {
"description": "Retention in days.\nRemove files older than X days.\n0 or lower means no retention.",
"format": "int32",
"type": "integer"
},
"retentionInMb": {
"description": "Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100.",
"format": "int32",
"maximum": 100,
"minimum": 25,
"type": "integer"
}
},
"type": "object"
},
"FunctionEnvelope": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Function information.",
"properties": {
"properties": {
"description": "FunctionEnvelope resource specific properties",
"properties": {
"config": {
"description": "Config information.",
"type": "object"
},
"config_href": {
"description": "Config URI.",
"type": "string"
},
"files": {
"additionalProperties": {
"type": "string"
},
"description": "File list.",
"type": "object"
},
"function_app_id": {
"description": "Function App ID.",
"type": "string"
},
"href": {
"description": "Function URI.",
"type": "string"
},
"invoke_url_template": {
"description": "The invocation URL",
"type": "string"
},
"isDisabled": {
"description": "Gets or sets a value indicating whether the function is disabled",
"type": "boolean"
},
"language": {
"description": "The function language",
"type": "string"
},
"script_href": {
"description": "Script URI.",
"type": "string"
},
"script_root_path_href": {
"description": "Script root path URI.",
"type": "string"
},
"secrets_file_href": {
"description": "Secrets file URI.",
"type": "string"
},
"test_data": {
"description": "Test data used when testing via the Azure Portal.",
"type": "string"
},
"test_data_href": {
"description": "Test data URI.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"FunctionEnvelopeCollection": {
"description": "Collection of Kudu function information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/FunctionEnvelope"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"FunctionSecrets": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Function secrets.",
"properties": {
"properties": {
"description": "FunctionSecrets resource specific properties",
"properties": {
"key": {
"description": "Secret key.",
"type": "string"
},
"trigger_url": {
"description": "Trigger URL.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"HostKeys": {
"description": "Functions host level keys.",
"properties": {
"functionKeys": {
"additionalProperties": {
"type": "string"
},
"description": "Host level function keys.",
"type": "object"
},
"masterKey": {
"description": "Secret key.",
"type": "string"
},
"systemKeys": {
"additionalProperties": {
"type": "string"
},
"description": "System keys.",
"type": "object"
}
},
"type": "object"
},
"HostNameBinding": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A hostname binding object.",
"properties": {
"properties": {
"description": "HostNameBinding resource specific properties",
"properties": {
"azureResourceName": {
"description": "Azure resource name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"azureResourceType": {
"description": "Azure resource type.",
"enum": [
"Website",
"TrafficManager"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AzureResourceType"
},
"x-ms-mutability": [
"create",
"read"
]
},
"customHostNameDnsRecordType": {
"description": "Custom DNS record type.",
"enum": [
"CName",
"A"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "CustomHostNameDnsRecordType"
},
"x-ms-mutability": [
"create",
"read"
]
},
"domainId": {
"description": "Fully qualified ARM domain resource URI.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"hostNameType": {
"description": "Hostname type.",
"enum": [
"Verified",
"Managed"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostNameType"
},
"x-ms-mutability": [
"create",
"read"
]
},
"siteName": {
"description": "App Service app name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sslState": {
"description": "SSL type",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
},
"x-ms-mutability": [
"create",
"read"
]
},
"thumbprint": {
"description": "SSL certificate thumbprint",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"HostNameBindingCollection": {
"description": "Collection of hostname bindings.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/HostNameBinding"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"HttpLogsConfig": {
"description": "Http logs configuration.",
"properties": {
"azureBlobStorage": {
"$ref": "#/definitions/AzureBlobStorageHttpLogsConfig",
"description": "Http logs to azure blob storage configuration."
},
"fileSystem": {
"$ref": "#/definitions/FileSystemHttpLogsConfig",
"description": "Http logs to file system configuration."
}
},
"type": "object"
},
"KeyInfo": {
"description": "Function key info.",
"properties": {
"name": {
"description": "Key name",
"type": "string"
},
"value": {
"description": "Key value",
"type": "string"
}
},
"type": "object"
},
"KeyVaultReferenceCollection": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Web app key vault reference and status ARM resource.",
"properties": {
"properties": {
"description": "KeyVaultReferenceCollection resource specific properties",
"properties": {
"keyToReferenceStatuses": {
"additionalProperties": {
"$ref": "#/definitions/ApiKVReference"
},
"type": "object"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"KeyVaultReferenceResource": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Web app key vault reference and status ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/ApiKVReference",
"description": "Core resource properties",
"properties": {
"details": {
"type": "string"
},
"identityType": {
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"location": {
"enum": [
"ApplicationSetting"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConfigReferenceLocation"
}
},
"reference": {
"type": "string"
},
"secretName": {
"type": "string"
},
"secretVersion": {
"type": "string"
},
"source": {
"enum": [
"KeyVault"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConfigReferenceSource"
}
},
"status": {
"enum": [
"Initialized",
"Resolved",
"InvalidSyntax",
"MSINotEnabled",
"VaultNotFound",
"SecretNotFound",
"SecretVersionNotFound",
"AccessToKeyVaultDenied",
"OtherReasons"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ResolveStatus"
}
},
"vaultName": {
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"MSDeploy": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "MSDeploy ARM PUT information",
"properties": {
"properties": {
"$ref": "#/definitions/MSDeployCore",
"description": "Core resource properties",
"properties": {
"addOnPackages": {
"description": "List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.",
"items": {
"$ref": "#/definitions/MSDeployCore"
},
"type": "array"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"MSDeployCore": {
"description": "MSDeploy ARM PUT core information",
"properties": {
"appOffline": {
"description": "Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default.",
"type": "boolean"
},
"connectionString": {
"description": "SQL Connection String",
"type": "string"
},
"dbType": {
"description": "Database Type",
"type": "string"
},
"packageUri": {
"description": "Package URI",
"type": "string"
},
"setParameters": {
"additionalProperties": {
"type": "string"
},
"description": "MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.",
"type": "object"
},
"setParametersXmlFileUri": {
"description": "URI of MSDeploy Parameters file. Must not be set if SetParameters is used.",
"type": "string"
},
"skipAppData": {
"description": "Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default.",
"type": "boolean"
}
},
"type": "object"
},
"MSDeployLog": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "MSDeploy log",
"properties": {
"properties": {
"description": "MSDeployLog resource specific properties",
"properties": {
"entries": {
"description": "List of log entry messages",
"items": {
"$ref": "#/definitions/MSDeployLogEntry"
},
"readOnly": true,
"type": "array"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"MSDeployLogEntry": {
"description": "MSDeploy log entry",
"properties": {
"message": {
"description": "Log entry message",
"readOnly": true,
"type": "string"
},
"time": {
"description": "Timestamp of log entry",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Log entry type",
"enum": [
"Message",
"Warning",
"Error"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "MSDeployLogEntryType"
}
}
},
"type": "object"
},
"MSDeployStatus": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "MSDeploy ARM response",
"properties": {
"properties": {
"description": "MSDeployStatus resource specific properties",
"properties": {
"complete": {
"description": "Whether the deployment operation has completed",
"readOnly": true,
"type": "boolean"
},
"deployer": {
"description": "Username of deployer",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "End time of deploy operation",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state",
"enum": [
"accepted",
"running",
"succeeded",
"failed",
"canceled"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "MSDeployProvisioningState"
}
},
"startTime": {
"description": "Start time of deploy operation",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"MigrateMySqlRequest": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "MySQL migration request.",
"properties": {
"properties": {
"description": "MigrateMySqlRequest resource specific properties",
"properties": {
"connectionString": {
"description": "Connection string to the remote MySQL database.",
"type": "string"
},
"migrationType": {
"description": "The type of migration operation to be done",
"enum": [
"LocalToRemote",
"RemoteToLocal"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "MySqlMigrationType"
}
}
},
"required": [
"connectionString",
"migrationType"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"MigrateMySqlStatus": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "MySQL migration status.",
"properties": {
"properties": {
"description": "MigrateMySqlStatus resource specific properties",
"properties": {
"localMySqlEnabled": {
"description": "True if the web app has in app MySql enabled",
"readOnly": true,
"type": "boolean"
},
"migrationOperationStatus": {
"description": "Status of the migration task.",
"enum": [
"InProgress",
"Failed",
"Succeeded",
"TimedOut",
"Created"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "OperationStatus"
}
},
"operationId": {
"description": "Operation ID for the migration task.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"NetworkFeatures": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Full view of network features for an app (presently VNET integration and Hybrid Connections).",
"properties": {
"properties": {
"description": "NetworkFeatures resource specific properties",
"properties": {
"hybridConnections": {
"description": "The Hybrid Connections summary view.",
"items": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
},
"readOnly": true,
"type": "array"
},
"hybridConnectionsV2": {
"description": "The Hybrid Connection V2 (Service Bus) view.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"description": "HybridConnection resource specific properties",
"properties": {
"hostname": {
"description": "The hostname of the endpoint.",
"type": "string"
},
"port": {
"description": "The port of the endpoint.",
"format": "int32",
"type": "integer"
},
"relayArmUri": {
"description": "The ARM URI to the Service Bus relay.",
"type": "string"
},
"relayName": {
"description": "The name of the Service Bus relay.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"sendKeyName": {
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
"type": "string"
},
"sendKeyValue": {
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead.",
"type": "string"
},
"serviceBusNamespace": {
"description": "The name of the Service Bus namespace.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"serviceBusSuffix": {
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"virtualNetworkConnection": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network information contract.",
"properties": {
"properties": {
"description": "VnetInfo resource specific properties",
"properties": {
"certBlob": {
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
"type": "string"
},
"certThumbprint": {
"description": "The client certificate thumbprint.",
"readOnly": true,
"type": "string"
},
"dnsServers": {
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
"type": "string"
},
"isSwift": {
"description": "Flag that is used to denote if this is VNET injection",
"type": "boolean"
},
"resyncRequired": {
"description": "true if a resync is required; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"routes": {
"description": "The routes that this Virtual Network connection uses.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"description": "VnetRoute resource specific properties",
"properties": {
"endAddress": {
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
"type": "string"
},
"routeType": {
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "RouteType"
}
},
"startAddress": {
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"vnetResourceId": {
"description": "The Virtual Network's resource ID.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"virtualNetworkName": {
"description": "The Virtual Network name.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"NetworkTrace": {
"description": "Network trace",
"properties": {
"message": {
"description": "Detailed message of a network trace operation, e.g. error message in case of failure.",
"type": "string"
},
"path": {
"description": "Local file path for the captured network trace file.",
"type": "string"
},
"status": {
"description": "Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed).",
"type": "string"
}
},
"type": "object"
},
"PerfMonCounterCollection": {
"description": "Collection of performance monitor counters.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/PerfMonResponse"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"PerfMonResponse": {
"description": "Performance monitor API response.",
"properties": {
"code": {
"description": "The response code.",
"type": "string"
},
"data": {
"$ref": "#/definitions/PerfMonSet",
"description": "The performance monitor counters."
},
"message": {
"description": "The message.",
"type": "string"
}
},
"type": "object"
},
"PerfMonSample": {
"description": "Performance monitor sample in a set.",
"properties": {
"instanceName": {
"description": "Name of the server on which the measurement is made.",
"type": "string"
},
"time": {
"description": "Point in time for which counter was measured.",
"format": "date-time",
"type": "string"
},
"value": {
"description": "Value of counter at a certain time.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"PerfMonSet": {
"description": "Metric information.",
"properties": {
"endTime": {
"description": "End time of the period.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Unique key name of the counter.",
"type": "string"
},
"startTime": {
"description": "Start time of the period.",
"format": "date-time",
"type": "string"
},
"timeGrain": {
"description": "Presented time grain.",
"type": "string"
},
"values": {
"description": "Collection of workers that are active during this time.",
"items": {
"$ref": "#/definitions/PerfMonSample"
},
"type": "array"
}
},
"type": "object"
},
"PremierAddOn": {
"allOf": [
{
"description": "Azure resource. This resource is tracked in Azure Resource Manager",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"location": {
"description": "Resource Location.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
}
],
"description": "Premier add-on.",
"properties": {
"properties": {
"description": "PremierAddOn resource specific properties",
"properties": {
"marketplaceOffer": {
"description": "Premier add on Marketplace offer.",
"type": "string"
},
"marketplacePublisher": {
"description": "Premier add on Marketplace publisher.",
"type": "string"
},
"product": {
"description": "Premier add on Product.",
"type": "string"
},
"sku": {
"description": "Premier add on SKU.",
"type": "string"
},
"vendor": {
"description": "Premier add on Vendor.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"PremierAddOnPatchResource": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "ARM resource for a PremierAddOn.",
"properties": {
"properties": {
"description": "PremierAddOnPatchResource resource specific properties",
"properties": {
"marketplaceOffer": {
"description": "Premier add on Marketplace offer.",
"type": "string"
},
"marketplacePublisher": {
"description": "Premier add on Marketplace publisher.",
"type": "string"
},
"product": {
"description": "Premier add on Product.",
"type": "string"
},
"sku": {
"description": "Premier add on SKU.",
"type": "string"
},
"vendor": {
"description": "Premier add on Vendor.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"PrivateAccess": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Description of the parameters of Private Access for a Web Site.",
"properties": {
"properties": {
"description": "PrivateAccess resource specific properties",
"properties": {
"enabled": {
"description": "Whether private access is enabled or not.",
"type": "boolean"
},
"virtualNetworks": {
"description": "The Virtual Networks (and subnets) allowed to access the site privately.",
"items": {
"$ref": "#/definitions/PrivateAccessVirtualNetwork"
},
"type": "array"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"PrivateAccessSubnet": {
"description": "Description of a Virtual Network subnet that is useable for private site access.",
"properties": {
"key": {
"description": "The key (ID) of the subnet.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "The name of the subnet.",
"type": "string"
}
},
"type": "object"
},
"PrivateAccessVirtualNetwork": {
"description": "Description of a Virtual Network that is useable for private site access.",
"properties": {
"key": {
"description": "The key (ID) of the Virtual Network.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "The name of the Virtual Network.",
"type": "string"
},
"resourceId": {
"description": "The ARM uri of the Virtual Network",
"type": "string"
},
"subnets": {
"description": "A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.",
"items": {
"$ref": "#/definitions/PrivateAccessSubnet"
},
"type": "array"
}
},
"type": "object"
},
"ProcessInfo": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Process Information.",
"properties": {
"properties": {
"description": "ProcessInfo resource specific properties",
"properties": {
"children": {
"description": "Child process list.",
"items": {
"type": "string"
},
"type": "array"
},
"command_line": {
"description": "Command line.",
"type": "string"
},
"deployment_name": {
"description": "Deployment name.",
"type": "string"
},
"description": {
"description": "Description of process.",
"type": "string"
},
"environment_variables": {
"additionalProperties": {
"type": "string"
},
"description": "List of environment variables.",
"type": "object"
},
"file_name": {
"description": "File name of this process.",
"type": "string"
},
"handle_count": {
"description": "Handle count.",
"format": "int32",
"type": "integer"
},
"href": {
"description": "HRef URI.",
"type": "string"
},
"identifier": {
"description": "ARM Identifier for deployment.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"iis_profile_timeout_in_seconds": {
"description": "IIS Profile timeout (seconds).",
"format": "double",
"type": "number"
},
"is_iis_profile_running": {
"description": "Is the IIS Profile running?",
"type": "boolean"
},
"is_profile_running": {
"description": "Is profile running?",
"type": "boolean"
},
"is_scm_site": {
"description": "Is this the SCM site?",
"type": "boolean"
},
"is_webjob": {
"description": "Is this a Web Job?",
"type": "boolean"
},
"minidump": {
"description": "Minidump URI.",
"type": "string"
},
"module_count": {
"description": "Module count.",
"format": "int32",
"type": "integer"
},
"modules": {
"description": "List of modules.",
"items": {
"$ref": "#/definitions/ProcessModuleInfo"
},
"type": "array"
},
"non_paged_system_memory": {
"description": "Non-paged system memory.",
"format": "int64",
"type": "integer"
},
"open_file_handles": {
"description": "List of open files.",
"items": {
"type": "string"
},
"type": "array"
},
"paged_memory": {
"description": "Paged memory.",
"format": "int64",
"type": "integer"
},
"paged_system_memory": {
"description": "Paged system memory.",
"format": "int64",
"type": "integer"
},
"parent": {
"description": "Parent process.",
"type": "string"
},
"peak_paged_memory": {
"description": "Peak paged memory.",
"format": "int64",
"type": "integer"
},
"peak_virtual_memory": {
"description": "Peak virtual memory usage.",
"format": "int64",
"type": "integer"
},
"peak_working_set": {
"description": "Peak working set.",
"format": "int64",
"type": "integer"
},
"private_memory": {
"description": "Private memory size.",
"format": "int64",
"type": "integer"
},
"privileged_cpu_time": {
"description": "Privileged CPU time.",
"type": "string"
},
"start_time": {
"description": "Start time.",
"format": "date-time",
"type": "string"
},
"thread_count": {
"description": "Thread count.",
"format": "int32",
"type": "integer"
},
"threads": {
"description": "Thread list.",
"items": {
"$ref": "#/definitions/ProcessThreadInfo"
},
"type": "array"
},
"time_stamp": {
"description": "Time stamp.",
"format": "date-time",
"type": "string"
},
"total_cpu_time": {
"description": "Total CPU time.",
"type": "string"
},
"user_cpu_time": {
"description": "User CPU time.",
"type": "string"
},
"user_name": {
"description": "User name.",
"type": "string"
},
"virtual_memory": {
"description": "Virtual memory size.",
"format": "int64",
"type": "integer"
},
"working_set": {
"description": "Working set.",
"format": "int64",
"type": "integer"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ProcessInfoCollection": {
"description": "Collection of Kudu process information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/ProcessInfo"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"ProcessModuleInfo": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Process Module Information.",
"properties": {
"properties": {
"description": "ProcessModuleInfo resource specific properties",
"properties": {
"base_address": {
"description": "Base address. Used as module identifier in ARM resource URI.",
"type": "string"
},
"file_description": {
"description": "File description.",
"type": "string"
},
"file_name": {
"description": "File name.",
"type": "string"
},
"file_path": {
"description": "File path.",
"type": "string"
},
"file_version": {
"description": "File version.",
"type": "string"
},
"href": {
"description": "HRef URI.",
"type": "string"
},
"is_debug": {
"description": "Is debug?",
"type": "boolean"
},
"language": {
"description": "Module language (locale).",
"type": "string"
},
"module_memory_size": {
"description": "Module memory size.",
"format": "int32",
"type": "integer"
},
"product": {
"description": "Product name.",
"type": "string"
},
"product_version": {
"description": "Product version.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ProcessModuleInfoCollection": {
"description": "Collection of Kudu thread information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/ProcessModuleInfo"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"ProcessThreadInfo": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Process Thread Information.",
"properties": {
"properties": {
"description": "ProcessThreadInfo resource specific properties",
"properties": {
"base_priority": {
"description": "Base priority.",
"format": "int32",
"type": "integer"
},
"current_priority": {
"description": "Current thread priority.",
"format": "int32",
"type": "integer"
},
"href": {
"description": "HRef URI.",
"type": "string"
},
"identifier": {
"description": "Site extension ID.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"priority_level": {
"description": "Thread priority level.",
"type": "string"
},
"process": {
"description": "Process URI.",
"type": "string"
},
"start_address": {
"description": "Start address.",
"type": "string"
},
"start_time": {
"description": "Start time.",
"format": "date-time",
"type": "string"
},
"state": {
"description": "Thread state.",
"type": "string"
},
"total_processor_time": {
"description": "Total processor time.",
"type": "string"
},
"user_processor_time": {
"description": "User processor time.",
"type": "string"
},
"wait_reason": {
"description": "Wait reason.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ProcessThreadInfoCollection": {
"description": "Collection of Kudu thread information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/ProcessThreadInfo"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"PublicCertificate": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Public certificate object",
"properties": {
"properties": {
"description": "PublicCertificate resource specific properties",
"properties": {
"blob": {
"description": "Public Certificate byte array",
"format": "byte",
"type": "string"
},
"publicCertificateLocation": {
"description": "Public Certificate Location",
"enum": [
"CurrentUserMy",
"LocalMachineMy",
"Unknown"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "PublicCertificateLocation"
}
},
"thumbprint": {
"description": "Certificate Thumbprint",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"PublicCertificateCollection": {
"description": "Collection of public certificates",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/PublicCertificate"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"RelayServiceConnectionEntity": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Hybrid Connection for an App Service app.",
"properties": {
"properties": {
"description": "RelayServiceConnectionEntity resource specific properties",
"properties": {
"biztalkUri": {
"type": "string"
},
"entityConnectionString": {
"type": "string"
},
"entityName": {
"type": "string"
},
"hostname": {
"type": "string"
},
"port": {
"format": "int32",
"type": "integer"
},
"resourceConnectionString": {
"type": "string"
},
"resourceType": {
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"RestoreRequest": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Description of a restore request.",
"properties": {
"properties": {
"description": "RestoreRequest resource specific properties",
"properties": {
"adjustConnectionStrings": {
"description": "true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.",
"type": "boolean"
},
"appServicePlan": {
"description": "Specify app service plan that will own restored site.",
"type": "string"
},
"blobName": {
"description": "Name of a blob which contains the backup.",
"type": "string"
},
"databases": {
"description": "Collection of databases which should be restored. This list has to match the list of databases included in the backup.",
"items": {
"$ref": "#/definitions/DatabaseBackupSetting"
},
"type": "array"
},
"hostingEnvironment": {
"description": "App Service Environment name, if needed (only when restoring an app to an App Service Environment).",
"type": "string"
},
"ignoreConflictingHostNames": {
"default": false,
"description": "Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to \nthe app's object when it is being restored, but that might fail due to conflicts during the operation.",
"type": "boolean"
},
"ignoreDatabases": {
"default": false,
"description": "Ignore the databases and only restore the site content",
"type": "boolean"
},
"operationType": {
"default": "Default",
"description": "Operation type.",
"enum": [
"Default",
"Clone",
"Relocation",
"Snapshot",
"CloudFS"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "BackupRestoreOperationType"
}
},
"overwrite": {
"description": "true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.",
"type": "boolean"
},
"siteName": {
"description": "Name of an app.",
"type": "string"
},
"storageAccountUrl": {
"description": "SAS URL to the container.",
"type": "string"
}
},
"required": [
"storageAccountUrl",
"overwrite"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SiteAuthSettings": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Configuration settings for the Azure App Service Authentication / Authorization feature.",
"properties": {
"properties": {
"description": "SiteAuthSettings resource specific properties",
"properties": {
"additionalLoginParams": {
"description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".",
"items": {
"type": "string"
},
"type": "array"
},
"allowedAudiences": {
"description": "Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting.",
"items": {
"type": "string"
},
"type": "array"
},
"allowedExternalRedirectUrls": {
"description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.",
"items": {
"type": "string"
},
"type": "array"
},
"clientId": {
"description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html",
"type": "string"
},
"clientSecret": {
"description": "The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html",
"type": "string"
},
"clientSecretCertificateThumbprint": {
"description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional.",
"type": "string"
},
"defaultProvider": {
"description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\".",
"enum": [
"AzureActiveDirectory",
"Facebook",
"Google",
"MicrosoftAccount",
"Twitter"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "BuiltInAuthenticationProvider"
}
},
"enabled": {
"description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.",
"type": "boolean"
},
"facebookAppId": {
"description": "The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login",
"type": "string"
},
"facebookAppSecret": {
"description": "The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login",
"type": "string"
},
"facebookOAuthScopes": {
"description": "The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login",
"items": {
"type": "string"
},
"type": "array"
},
"googleClientId": {
"description": "The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/",
"type": "string"
},
"googleClientSecret": {
"description": "The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/",
"type": "string"
},
"googleOAuthScopes": {
"description": "The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/",
"items": {
"type": "string"
},
"type": "array"
},
"issuer": {
"description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html",
"type": "string"
},
"microsoftAccountClientId": {
"description": "The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm",
"type": "string"
},
"microsoftAccountClientSecret": {
"description": "The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm",
"type": "string"
},
"microsoftAccountOAuthScopes": {
"description": "The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx",
"items": {
"type": "string"
},
"type": "array"
},
"runtimeVersion": {
"description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module.",
"type": "string"
},
"tokenRefreshExtensionHours": {
"description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours.",
"format": "double",
"type": "number"
},
"tokenStoreEnabled": {
"description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false.",
"type": "boolean"
},
"twitterConsumerKey": {
"description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in",
"type": "string"
},
"twitterConsumerSecret": {
"description": "The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in",
"type": "string"
},
"unauthenticatedClientAction": {
"description": "The action to take when an unauthenticated client attempts to access the app.",
"enum": [
"RedirectToLoginPage",
"AllowAnonymous"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UnauthenticatedClientAction"
}
},
"validateIssuer": {
"description": "Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.",
"type": "boolean"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SiteCloneability": {
"description": "Represents whether or not an app is cloneable.",
"properties": {
"blockingCharacteristics": {
"description": "List of blocking application characteristics.",
"items": {
"$ref": "#/definitions/SiteCloneabilityCriterion"
},
"type": "array"
},
"blockingFeatures": {
"description": "List of features enabled on app that prevent cloning.",
"items": {
"$ref": "#/definitions/SiteCloneabilityCriterion"
},
"type": "array"
},
"result": {
"description": "Name of app.",
"enum": [
"Cloneable",
"PartiallyCloneable",
"NotCloneable"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "CloneAbilityResult"
}
},
"unsupportedFeatures": {
"description": "List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned\nbut the features in this list will not be set up on cloned app.",
"items": {
"$ref": "#/definitions/SiteCloneabilityCriterion"
},
"type": "array"
}
},
"type": "object"
},
"SiteCloneabilityCriterion": {
"description": "An app cloneability criterion.",
"properties": {
"description": {
"description": "Description of criterion.",
"type": "string"
},
"name": {
"description": "Name of criterion.",
"type": "string"
}
},
"type": "object"
},
"SiteConfigResource": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Web app configuration ARM resource.",
"properties": {
"properties": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"SiteConfigResourceCollection": {
"description": "Collection of site configurations.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/SiteConfigResource"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"SiteConfigurationSnapshotInfo": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A snapshot of a web app configuration.",
"properties": {
"properties": {
"description": "SiteConfigurationSnapshotInfo resource specific properties",
"properties": {
"snapshotId": {
"description": "The id of the snapshot",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"time": {
"description": "The time the snapshot was taken.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SiteConfigurationSnapshotInfoCollection": {
"description": "Collection of metadata for the app configuration snapshots that can be restored.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/SiteConfigurationSnapshotInfo"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"SiteExtensionInfo": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Site Extension Information.",
"properties": {
"properties": {
"description": "SiteExtensionInfo resource specific properties",
"properties": {
"authors": {
"description": "List of authors.",
"items": {
"type": "string"
},
"type": "array"
},
"comment": {
"description": "Site Extension comment.",
"type": "string"
},
"description": {
"description": "Detailed description.",
"type": "string"
},
"download_count": {
"description": "Count of downloads.",
"format": "int32",
"type": "integer"
},
"extension_id": {
"description": "Site extension ID.",
"type": "string"
},
"extension_type": {
"description": "Site extension type.",
"enum": [
"Gallery",
"WebRoot"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteExtensionType"
}
},
"extension_url": {
"description": "Extension URL.",
"type": "string"
},
"feed_url": {
"description": "Feed URL.",
"type": "string"
},
"icon_url": {
"description": "Icon URL.",
"type": "string"
},
"installed_date_time": {
"description": "Installed timestamp.",
"format": "date-time",
"type": "string"
},
"installer_command_line_params": {
"description": "Installer command line parameters.",
"type": "string"
},
"license_url": {
"description": "License URL.",
"type": "string"
},
"local_is_latest_version": {
"description": "true if the local version is the latest version; false otherwise.",
"type": "boolean"
},
"local_path": {
"description": "Local path.",
"type": "string"
},
"project_url": {
"description": "Project URL.",
"type": "string"
},
"provisioningState": {
"description": "Provisioning state.",
"type": "string"
},
"published_date_time": {
"description": "Published timestamp.",
"format": "date-time",
"type": "string"
},
"summary": {
"description": "Summary description.",
"type": "string"
},
"title": {
"type": "string"
},
"version": {
"description": "Version information.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SiteExtensionInfoCollection": {
"description": "Collection of Kudu site extension information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/SiteExtensionInfo"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"SiteInstance": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Instance of an app.",
"properties": {
"properties": {
"description": "SiteInstance resource specific properties",
"properties": {
"siteInstanceName": {
"description": "Name of instance.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SiteLogsConfig": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Configuration of App Service site logs.",
"properties": {
"properties": {
"description": "SiteLogsConfig resource specific properties",
"properties": {
"applicationLogs": {
"$ref": "#/definitions/ApplicationLogsConfig",
"description": "Application logs configuration."
},
"detailedErrorMessages": {
"$ref": "#/definitions/EnabledConfig",
"description": "Detailed error messages configuration."
},
"failedRequestsTracing": {
"$ref": "#/definitions/EnabledConfig",
"description": "Failed requests tracing configuration."
},
"httpLogs": {
"$ref": "#/definitions/HttpLogsConfig",
"description": "HTTP logs configuration."
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SitePatchResource": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "ARM resource for a site.",
"properties": {
"identity": {
"description": "Managed service identity.",
"properties": {
"principalId": {
"description": "Principal Id of managed service identity.",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant of managed service identity.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of managed service identity.",
"enum": [
"None",
"SystemAssigned",
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "Client Id of user assigned identity",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "Principal Id of user assigned identity",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"type": "object"
}
},
"type": "object"
},
"properties": {
"description": "SitePatchResource resource specific properties",
"properties": {
"availabilityState": {
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteAvailabilityState"
}
},
"clientAffinityEnabled": {
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
"type": "boolean"
},
"clientCertExclusionPaths": {
"description": "client certificate authentication comma-separated exclusion paths",
"type": "string"
},
"cloningInfo": {
"description": "Information needed for cloning operation.",
"properties": {
"appSettingsOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained.",
"type": "object"
},
"cloneCustomHostNames": {
"description": "true to clone custom hostnames from source app; otherwise, false.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "true to clone source control from source app; otherwise, false.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "true to configure load balancing for source and destination app.",
"type": "boolean"
},
"correlationId": {
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"type": "string"
},
"hostingEnvironment": {
"description": "App Service Environment.",
"type": "string"
},
"overwrite": {
"description": "true to overwrite destination app; otherwise, false.",
"type": "boolean"
},
"sourceWebAppId": {
"description": "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"sourceWebAppLocation": {
"description": "Location of source app ex: West US or North Europe",
"type": "string"
},
"trafficManagerProfileId": {
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
"type": "string"
},
"trafficManagerProfileName": {
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
"type": "string"
}
},
"required": [
"sourceWebAppId"
],
"type": "object"
},
"containerSize": {
"description": "Size of the function container.",
"format": "int32",
"type": "integer"
},
"dailyMemoryTimeQuota": {
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
"format": "int32",
"type": "integer"
},
"defaultHostName": {
"description": "Default hostname of the app. Read-only.",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
"type": "boolean"
},
"enabledHostNames": {
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNameSslStates": {
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"description": "SSL-enabled hostname.",
"properties": {
"hostType": {
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostType"
}
},
"name": {
"description": "Hostname.",
"type": "string"
},
"sslState": {
"description": "SSL type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SslState"
}
},
"thumbprint": {
"description": "SSL certificate thumbprint.",
"type": "string"
},
"toUpdate": {
"description": "Set to true to update existing hostname.",
"type": "boolean"
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostNames": {
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"hostNamesDisabled": {
"description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
"type": "boolean"
},
"hostingEnvironmentProfile": {
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"description": "Resource ID of the App Service Environment.",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type of the App Service Environment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"httpsOnly": {
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
"type": "boolean"
},
"hyperV": {
"default": false,
"description": "Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"inProgressOperationId": {
"description": "Specifies an operation id if this site has a pending operation.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"isDefaultContainer": {
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true,
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: Hyper-V sandbox.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"lastModifiedTimeUtc": {
"description": "Last time the app was modified, in UTC. Read-only.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"maxNumberOfWorkers": {
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"outboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true,
"type": "string"
},
"possibleOutboundIpAddresses": {
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true,
"type": "string"
},
"redundancyMode": {
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RedundancyMode"
}
},
"repositorySiteName": {
"description": "Name of the repository site.",
"readOnly": true,
"type": "string"
},
"reserved": {
"default": false,
"description": "true if reserved; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true,
"type": "string"
},
"scmSiteAlsoStopped": {
"default": false,
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"type": "boolean"
},
"serverFarmId": {
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
"type": "string"
},
"siteConfig": {
"description": "Configuration of an App Service app.",
"properties": {
"alwaysOn": {
"description": "true if Always On is enabled; otherwise, false.",
"type": "boolean"
},
"apiDefinition": {
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"description": "The URL of the API definition.",
"type": "string"
}
},
"type": "object"
},
"apiManagementConfig": {
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"description": "APIM-Api Identifier.",
"type": "string"
}
},
"type": "object"
},
"appCommandLine": {
"description": "App command line to launch.",
"type": "string"
},
"appSettings": {
"description": "Application settings.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"autoHealEnabled": {
"description": "true if Auto Heal is enabled; otherwise, false.",
"type": "boolean"
},
"autoHealRules": {
"description": "Rules that can be defined for auto-heal.",
"properties": {
"actions": {
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AutoHealActionType"
}
},
"customAction": {
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"description": "Executable to be run.",
"type": "string"
},
"parameters": {
"description": "Parameters for the executable.",
"type": "string"
}
},
"type": "object"
},
"minProcessExecutionTime": {
"description": "Minimum time the process must execute\nbefore taking the action",
"type": "string"
}
},
"type": "object"
},
"triggers": {
"description": "Triggers for auto-heal.",
"properties": {
"privateBytesInKB": {
"description": "A rule based on private bytes.",
"format": "int32",
"type": "integer"
},
"requests": {
"description": "Trigger based on total requests.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
}
},
"type": "object"
},
"slowRequests": {
"description": "Trigger based on request execution time.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"timeTaken": {
"description": "Time taken.",
"type": "string"
}
},
"type": "object"
},
"statusCodes": {
"description": "A rule based on status codes.",
"items": {
"description": "Trigger based on status code.",
"properties": {
"count": {
"description": "Request Count.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "HTTP status code.",
"format": "int32",
"type": "integer"
},
"subStatus": {
"description": "Request Sub Status.",
"format": "int32",
"type": "integer"
},
"timeInterval": {
"description": "Time interval.",
"type": "string"
},
"win32Status": {
"description": "Win32 error code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"autoSwapSlotName": {
"description": "Auto-swap slot name.",
"type": "string"
},
"connectionStrings": {
"description": "Connection strings.",
"items": {
"description": "Database connection string information.",
"properties": {
"connectionString": {
"description": "Connection string value.",
"type": "string"
},
"name": {
"description": "Name of connection string.",
"type": "string"
},
"type": {
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ConnectionStringType"
}
}
},
"type": "object"
},
"type": "array"
},
"cors": {
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
},
"type": "array"
},
"supportCredentials": {
"description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
"type": "boolean"
}
},
"type": "object"
},
"defaultDocuments": {
"description": "Default documents.",
"items": {
"type": "string"
},
"type": "array"
},
"detailedErrorLoggingEnabled": {
"description": "true if detailed error logging is enabled; otherwise, false.",
"type": "boolean"
},
"documentRoot": {
"description": "Document root.",
"type": "string"
},
"experiments": {
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"description": "List of ramp-up rules.",
"items": {
"description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
"properties": {
"actionHostName": {
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
"type": "string"
},
"changeDecisionCallbackUrl": {
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
"type": "string"
},
"changeIntervalInMinutes": {
"description": "Specifies interval in minutes to reevaluate ReroutePercentage.",
"format": "int32",
"type": "integer"
},
"changeStep": {
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
"format": "double",
"type": "number"
},
"maxReroutePercentage": {
"description": "Specifies upper boundary below which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"minReroutePercentage": {
"description": "Specifies lower boundary above which ReroutePercentage will stay.",
"format": "double",
"type": "number"
},
"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.",
"type": "string"
},
"reroutePercentage": {
"description": "Percentage of the traffic which will be redirected to ActionHostName.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ftpsState": {
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "FtpsState"
}
},
"handlerMappings": {
"description": "Handler mappings.",
"items": {
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"arguments": {
"description": "Command-line arguments to be passed to the script processor.",
"type": "string"
},
"extension": {
"description": "Requests with this extension will be handled using the specified FastCGI application.",
"type": "string"
},
"scriptProcessor": {
"description": "The absolute path to the FastCGI application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"healthCheckPath": {
"description": "Health check path",
"type": "string"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "true if HTTP logging is enabled; otherwise, false.",
"type": "boolean"
},
"ipSecurityRestrictions": {
"description": "IP security restrictions for main.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"javaContainer": {
"description": "Java container.",
"type": "string"
},
"javaContainerVersion": {
"description": "Java container version.",
"type": "string"
},
"javaVersion": {
"description": "Java version.",
"type": "string"
},
"limits": {
"description": "Metric limits set on an app.",
"properties": {
"maxDiskSizeInMb": {
"description": "Maximum allowed disk size usage in MB.",
"format": "int64",
"type": "integer"
},
"maxMemoryInMb": {
"description": "Maximum allowed memory usage in MB.",
"format": "int64",
"type": "integer"
},
"maxPercentageCpu": {
"description": "Maximum allowed CPU usage percentage.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"linuxFxVersion": {
"description": "Linux App Framework and version",
"type": "string"
},
"loadBalancing": {
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteLoadBalancing"
}
},
"localMySqlEnabled": {
"default": false,
"description": "true to enable local MySQL; otherwise, false.",
"type": "boolean"
},
"logsDirectorySizeLimit": {
"description": "HTTP logs directory size limit.",
"format": "int32",
"type": "integer"
},
"machineKey": {
"description": "MachineKey of an app.",
"properties": {
"decryption": {
"description": "Algorithm used for decryption.",
"type": "string"
},
"decryptionKey": {
"description": "Decryption key.",
"type": "string"
},
"validation": {
"description": "MachineKey validation.",
"type": "string"
},
"validationKey": {
"description": "Validation key.",
"type": "string"
}
},
"type": "object"
},
"managedPipelineMode": {
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ManagedPipelineMode"
}
},
"managedServiceIdentityId": {
"description": "Managed Service Identity Id",
"format": "int32",
"type": "integer"
},
"minTlsVersion": {
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "SupportedTlsVersions"
}
},
"netFrameworkVersion": {
"default": "v4.6",
"description": ".NET Framework version.",
"type": "string"
},
"nodeVersion": {
"description": "Version of Node.js.",
"type": "string"
},
"numberOfWorkers": {
"description": "Number of workers.",
"format": "int32",
"type": "integer"
},
"phpVersion": {
"description": "Version of PHP.",
"type": "string"
},
"preWarmedInstanceCount": {
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"publishingUsername": {
"description": "Publishing user name.",
"type": "string"
},
"push": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Push settings for the App.",
"properties": {
"properties": {
"description": "PushSettings resource specific properties",
"properties": {
"dynamicTagsJson": {
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.",
"type": "string"
},
"isPushEnabled": {
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler.",
"type": "string"
}
},
"required": [
"isPushEnabled"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"pythonVersion": {
"description": "Version of Python.",
"type": "string"
},
"remoteDebuggingEnabled": {
"description": "true if remote debugging is enabled; otherwise, false.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "true if request tracing is enabled; otherwise, false.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"scmIpSecurityRestrictions": {
"description": "IP security restrictions for scm.",
"items": {
"description": "IP security restriction on an app.",
"properties": {
"action": {
"description": "Allow or Deny access for this IP range.",
"type": "string"
},
"description": {
"description": "IP restriction rule description.",
"type": "string"
},
"ipAddress": {
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
"type": "string"
},
"name": {
"description": "IP restriction rule name.",
"type": "string"
},
"priority": {
"description": "Priority of IP restriction rule.",
"format": "int32",
"type": "integer"
},
"subnetMask": {
"description": "Subnet mask for the range of IP addresses the restriction is valid for.",
"type": "string"
},
"subnetTrafficTag": {
"description": "(internal) Subnet traffic tag",
"format": "int32",
"type": "integer"
},
"tag": {
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "IpFilterTag"
}
},
"vnetSubnetResourceId": {
"description": "Virtual network resource id",
"type": "string"
},
"vnetTrafficTag": {
"description": "(internal) Vnet traffic tag",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"scmIpSecurityRestrictionsUseMain": {
"description": "IP security restrictions for scm to use main.",
"type": "boolean"
},
"scmType": {
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "true to use 32-bit worker process; otherwise, false.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "true if preloading is enabled; otherwise, false.",
"type": "boolean"
},
"virtualDirectories": {
"description": "Virtual directories for virtual application.",
"items": {
"description": "Directory for virtual application.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"virtualPath": {
"description": "Path to virtual application.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"virtualPath": {
"description": "Virtual path.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"vnetName": {
"description": "Virtual Network name.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"webSocketsEnabled": {
"description": "true if WebSocket is enabled; otherwise, false.",
"type": "boolean"
},
"windowsFxVersion": {
"description": "Xenon App Framework and version",
"type": "string"
},
"xManagedServiceIdentityId": {
"description": "Explicit Managed Service Identity Id",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"slotSwapStatus": {
"description": "The status of the last successful slot swap operation.",
"properties": {
"destinationSlotName": {
"description": "The destination slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"sourceSlotName": {
"description": "The source slot of the last swap operation.",
"readOnly": true,
"type": "string"
},
"timestampUtc": {
"description": "The time the last successful slot swap completed.",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"state": {
"description": "Current state of the app.",
"readOnly": true,
"type": "string"
},
"suspendedTill": {
"description": "App suspended till in case memory-time quota is exceeded.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetSwapSlot": {
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true,
"type": "string"
},
"trafficManagerHostNames": {
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"usageState": {
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "UsageState"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SitePhpErrorLogFlag": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Used for getting PHP error logging flag.",
"properties": {
"properties": {
"description": "SitePhpErrorLogFlag resource specific properties",
"properties": {
"localLogErrors": {
"description": "Local log_errors setting.",
"type": "string"
},
"localLogErrorsMaxLength": {
"description": "Local log_errors_max_len setting.",
"type": "string"
},
"masterLogErrors": {
"description": "Master log_errors setting.",
"type": "string"
},
"masterLogErrorsMaxLength": {
"description": "Master log_errors_max_len setting.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SiteSourceControl": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Source control configuration for an app.",
"properties": {
"properties": {
"description": "SiteSourceControl resource specific properties",
"properties": {
"branch": {
"description": "Name of branch to use for deployment.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"deploymentRollbackEnabled": {
"description": "true to enable deployment rollback; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"isManualIntegration": {
"description": "true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"isMercurial": {
"description": "true for a Mercurial repository; false for a Git repository.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"repoUrl": {
"description": "Repository or source control URL.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SlotConfigNames": {
"description": "Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app.",
"properties": {
"appSettingNames": {
"description": "List of application settings names.",
"items": {
"type": "string"
},
"type": "array"
},
"azureStorageConfigNames": {
"description": "List of external Azure storage account identifiers.",
"items": {
"type": "string"
},
"type": "array"
},
"connectionStringNames": {
"description": "List of connection string names.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SlotConfigNamesResource": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Slot Config names azure resource.",
"properties": {
"properties": {
"$ref": "#/definitions/SlotConfigNames",
"description": "Core resource properties",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SlotDifference": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A setting difference between two deployment slots of an app.",
"properties": {
"properties": {
"description": "SlotDifference resource specific properties",
"properties": {
"description": {
"description": "Description of the setting difference.",
"readOnly": true,
"type": "string"
},
"diffRule": {
"description": "Rule that describes how to process the setting difference during a slot swap.",
"readOnly": true,
"type": "string"
},
"level": {
"description": "Level of the difference: Information, Warning or Error.",
"readOnly": true,
"type": "string"
},
"settingName": {
"description": "Name of the setting.",
"readOnly": true,
"type": "string"
},
"settingType": {
"description": "The type of the setting: General, AppSetting or ConnectionString.",
"readOnly": true,
"type": "string"
},
"valueInCurrentSlot": {
"description": "Value of the setting in the current slot.",
"readOnly": true,
"type": "string"
},
"valueInTargetSlot": {
"description": "Value of the setting in the target slot.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SlotDifferenceCollection": {
"description": "Collection of slot differences.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/SlotDifference"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"SnapshotCollection": {
"description": "Collection of snapshots which can be used to revert an app to a previous time.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "A snapshot of an app.",
"properties": {
"properties": {
"description": "Snapshot resource specific properties",
"properties": {
"time": {
"description": "The time the snapshot was taken.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"SnapshotRecoverySource": {
"description": "Specifies the web app that snapshot contents will be retrieved from.",
"properties": {
"id": {
"description": "ARM resource ID of the source app. \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
"type": "string"
},
"location": {
"description": "Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS",
"type": "string"
}
},
"type": "object"
},
"SnapshotRestoreRequest": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Details about app recovery operation.",
"properties": {
"properties": {
"description": "SnapshotRestoreRequest resource specific properties",
"properties": {
"ignoreConflictingHostNames": {
"description": "If true, custom hostname conflicts will be ignored when recovering to a target web app.\nThis setting is only necessary when RecoverConfiguration is enabled.",
"type": "boolean"
},
"overwrite": {
"description": "If true the restore operation can overwrite source app; otherwise, false.",
"type": "boolean"
},
"recoverConfiguration": {
"description": "If true, site configuration, in addition to content, will be reverted.",
"type": "boolean"
},
"recoverySource": {
"$ref": "#/definitions/SnapshotRecoverySource",
"description": "Optional. Specifies the web app that snapshot contents will be retrieved from.\nIf empty, the targeted web app will be used as the source."
},
"snapshotTime": {
"description": "Point in time in which the app restore should be done, formatted as a DateTime string.",
"type": "string"
},
"useDRSecondary": {
"description": "If true, the snapshot is retrieved from DRSecondary endpoint.",
"type": "boolean"
}
},
"required": [
"overwrite"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"StorageMigrationOptions": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Options for app content migration.",
"properties": {
"properties": {
"description": "StorageMigrationOptions resource specific properties",
"properties": {
"azurefilesConnectionString": {
"description": "AzureFiles connection string.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"azurefilesShare": {
"description": "AzureFiles share.",
"type": "string",
"x-ms-mutability": [
"create"
]
},
"blockWriteAccessToSite": {
"default": false,
"description": "true if the app should be read only during copy operation; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create"
]
},
"switchSiteAfterMigration": {
"default": false,
"description": "trueif the app should be switched over; otherwise, false.",
"type": "boolean",
"x-ms-mutability": [
"create"
]
}
},
"required": [
"azurefilesConnectionString",
"azurefilesShare"
],
"x-ms-client-flatten": true
}
},
"type": "object"
},
"StorageMigrationResponse": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Response for a migration of app content request.",
"properties": {
"properties": {
"description": "StorageMigrationResponse resource specific properties",
"properties": {
"operationId": {
"description": "When server starts the migration process, it will return an operation ID identifying that particular migration operation.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"StringDictionary": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "String dictionary resource.",
"properties": {
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Settings.",
"type": "object",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"SwiftVirtualNetwork": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.",
"properties": {
"properties": {
"description": "SwiftVirtualNetwork resource specific properties",
"properties": {
"subnetResourceId": {
"description": "The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.",
"type": "string"
},
"swiftSupported": {
"description": "A flag that specifies if the scale unit this Web App is on supports Swift integration.",
"type": "boolean"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"TriggeredJobHistory": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Triggered Web Job History. List of Triggered Web Job Run Information elements.",
"properties": {
"properties": {
"description": "TriggeredJobHistory resource specific properties",
"properties": {
"runs": {
"description": "List of triggered web job runs.",
"items": {
"$ref": "#/definitions/TriggeredJobRun"
},
"type": "array"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"TriggeredJobHistoryCollection": {
"description": "Collection of Kudu continuous web job information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/TriggeredJobHistory"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"TriggeredJobRun": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Triggered Web Job Run Information.",
"properties": {
"properties": {
"description": "TriggeredJobRun resource specific properties",
"properties": {
"duration": {
"description": "Job duration.",
"type": "string"
},
"end_time": {
"description": "End time.",
"format": "date-time",
"type": "string"
},
"error_url": {
"description": "Error URL.",
"type": "string"
},
"job_name": {
"description": "Job name.",
"type": "string"
},
"output_url": {
"description": "Output URL.",
"type": "string"
},
"start_time": {
"description": "Start time.",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Job status.",
"enum": [
"Success",
"Failed",
"Error"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "TriggeredWebJobStatus"
}
},
"trigger": {
"description": "Job trigger.",
"type": "string"
},
"url": {
"description": "Job URL.",
"type": "string"
},
"web_job_id": {
"description": "Job ID.",
"type": "string"
},
"web_job_name": {
"description": "Job name.",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"TriggeredWebJob": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Triggered Web Job Information.",
"properties": {
"properties": {
"description": "TriggeredWebJob resource specific properties",
"properties": {
"error": {
"description": "Error information.",
"type": "string"
},
"extra_info_url": {
"description": "Extra Info URL.",
"type": "string"
},
"history_url": {
"description": "History URL.",
"type": "string"
},
"latest_run": {
"$ref": "#/definitions/TriggeredJobRun",
"description": "Latest job run information."
},
"run_command": {
"description": "Run command.",
"type": "string"
},
"scheduler_logs_url": {
"description": "Scheduler Logs URL.",
"type": "string"
},
"settings": {
"additionalProperties": {
"type": "object"
},
"description": "Job settings.",
"type": "object"
},
"url": {
"description": "Job URL.",
"type": "string"
},
"using_sdk": {
"description": "Using SDK?",
"type": "boolean"
},
"web_job_type": {
"description": "Job type.",
"enum": [
"Continuous",
"Triggered"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "WebJobType"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"TriggeredWebJobCollection": {
"description": "Collection of Kudu continuous web job information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/TriggeredWebJob"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"WebAppInstanceCollection": {
"description": "Collection of app instances.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/SiteInstance"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"WebJob": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Web Job Information.",
"properties": {
"properties": {
"description": "WebJob resource specific properties",
"properties": {
"error": {
"description": "Error information.",
"type": "string"
},
"extra_info_url": {
"description": "Extra Info URL.",
"type": "string"
},
"run_command": {
"description": "Run command.",
"type": "string"
},
"settings": {
"additionalProperties": {
"type": "object"
},
"description": "Job settings.",
"type": "object"
},
"url": {
"description": "Job URL.",
"type": "string"
},
"using_sdk": {
"description": "Using SDK?",
"type": "boolean"
},
"web_job_type": {
"description": "Job type.",
"enum": [
"Continuous",
"Triggered"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "WebJobType"
}
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"WebJobCollection": {
"description": "Collection of Kudu web job information elements.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/WebJob"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"WebSiteInstanceStatus": {
"allOf": [
{
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"kind": {
"description": "Kind of resource.",
"type": "string"
},
"name": {
"description": "Resource Name.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"properties": {
"properties": {
"description": "WebSiteInstanceStatus resource specific properties",
"properties": {
"consoleUrl": {
"description": "Link to the Diagnose and Solve Portal",
"type": "string"
},
"containers": {
"additionalProperties": {
"$ref": "#/definitions/ContainerInfo"
},
"type": "object"
},
"detectorUrl": {
"description": "Link to the Diagnose and Solve Portal",
"type": "string"
},
"state": {
"enum": [
"READY",
"STOPPED",
"UNKNOWN"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "SiteRuntimeState"
}
},
"statusUrl": {
"description": "Link to the GetStatusApi in Kudu",
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
}
}
}