AppServiceEnvironments API Client
Connect to AppServiceEnvironments API Client with 1 MCP tools for AI-powered API automation.
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"title": "AppServiceEnvironments API Client",
"version": "2018-02-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/2018-02-01/AppServiceEnvironments.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "azure.com",
"x-serviceName": "web-AppServiceEnvironments",
"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/hostingEnvironments": {
"get": {
"description": "Get all App Service Environments for a subscription.",
"operationId": "AppServiceEnvironments_List",
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 App Service Environments for a subscription.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments": {
"get": {
"description": "Get all App Service Environments in a resource group.",
"operationId": "AppServiceEnvironments_ListByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 App Service Environments in a resource group.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}": {
"delete": {
"description": "Delete an App Service Environment.",
"operationId": "AppServiceEnvironments_Delete",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Specify <code>true</code> to force the deletion even if the App Service Environment contains resources. The default is <code>false</code>.",
"in": "query",
"name": "forceDelete",
"type": "boolean"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"202": {
"description": "Operation is in progress."
},
"204": {
"description": "App Service Environment does not exist"
},
"400": {
"description": "Bad request."
},
"404": {
"description": "Not found."
},
"409": {
"description": "Conflict."
}
},
"summary": "Delete an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-long-running-operation": true
},
"get": {
"description": "Get the properties of an App Service Environment.",
"operationId": "AppServiceEnvironments_Get",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 properties of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
]
},
"patch": {
"description": "Create or update an App Service Environment.",
"operationId": "AppServiceEnvironments_Update",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Configuration details of the App Service Environment.",
"in": "body",
"name": "hostingEnvironmentEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentPatchResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"400": {
"description": "Bad request."
},
"404": {
"description": "Not found."
},
"409": {
"description": "Conflict."
}
},
"summary": "Create or update an App Service Environment.",
"tags": [
"AppServiceEnvironments"
]
},
"put": {
"description": "Create or update an App Service Environment.",
"operationId": "AppServiceEnvironments_CreateOrUpdate",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Configuration details of the App Service Environment.",
"in": "body",
"name": "hostingEnvironmentEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"400": {
"description": "Bad request."
},
"404": {
"description": "Not found."
},
"409": {
"description": "Conflict."
}
},
"summary": "Create or update an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute": {
"get": {
"description": "Get the used, available, and total worker capacity an App Service Environment.",
"operationId": "AppServiceEnvironments_ListCapacities",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/StampCapacityCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 used, available, and total worker capacity an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip": {
"get": {
"description": "Get IP addresses assigned to an App Service Environment.",
"operationId": "AppServiceEnvironments_ListVips",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AddressResponse"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 IP addresses assigned to an App Service Environment.",
"tags": [
"AppServiceEnvironments"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork": {
"post": {
"description": "Move an App Service Environment to a different VNET.",
"operationId": "AppServiceEnvironments_ChangeVnet",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Details for the new virtual network.",
"in": "body",
"name": "vnetInfo",
"required": true,
"schema": {
"description": "Specification for using a Virtual Network.",
"properties": {
"id": {
"description": "Resource id of the Virtual Network.",
"type": "string"
},
"name": {
"description": "Name of the Virtual Network (read-only).",
"readOnly": true,
"type": "string"
},
"subnet": {
"description": "Subnet within the Virtual Network.",
"type": "string"
},
"type": {
"description": "Resource type of the Virtual Network (read-only).",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
},
{
"$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": [
"SystemAssigned",
"UserAssigned",
"SystemAssigned, UserAssigned",
"None"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"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": "<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.",
"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": "<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "<code>true</code> to clone source control from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "<code>true</code> 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": "<code>true</code> to overwrite destination app; otherwise, <code>false</code>.",
"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": "<code>true</code> if the app is enabled; otherwise, <code>false</code>. 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"
},
"geoDistributions": {
"description": "GeoDistributions for this site",
"items": {
"description": "A global distribution definition.",
"properties": {
"location": {
"description": "Location.",
"type": "string"
},
"numberOfWorkers": {
"description": "NumberOfWorkers.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"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 <code>true</code> 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": "<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.\n If <code>true</code>, 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": "<code>true</code> if the app is a default container; otherwise, <code>false</code>.",
"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. 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": "<code>true</code> if reserved; otherwise, <code>false</code>.",
"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": "<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.",
"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": "<code>true</code> if Always On is enabled; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.",
"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"
},
"azureStorageAccounts": {
"additionalProperties": {
"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"
},
"description": "User-provided Azure storage accounts.",
"type": "object"
},
"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": "<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.",
"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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.",
"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 <code>ActionHostName</code>.",
"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"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> to enable local MySQL; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"reservedInstanceCount": {
"description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"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"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "<code>true</code> if preloading is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.",
"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"
}
},
"202": {
"description": "Operation is in progress.",
"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": [
"SystemAssigned",
"UserAssigned",
"SystemAssigned, UserAssigned",
"None"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"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": "<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.",
"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": "<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "<code>true</code> to clone source control from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "<code>true</code> 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": "<code>true</code> to overwrite destination app; otherwise, <code>false</code>.",
"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": "<code>true</code> if the app is enabled; otherwise, <code>false</code>. 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"
},
"geoDistributions": {
"description": "GeoDistributions for this site",
"items": {
"description": "A global distribution definition.",
"properties": {
"location": {
"description": "Location.",
"type": "string"
},
"numberOfWorkers": {
"description": "NumberOfWorkers.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"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 <code>true</code> 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": "<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.\n If <code>true</code>, 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": "<code>true</code> if the app is a default container; otherwise, <code>false</code>.",
"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. 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": "<code>true</code> if reserved; otherwise, <code>false</code>.",
"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": "<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.",
"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": "<code>true</code> if Always On is enabled; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.",
"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"
},
"azureStorageAccounts": {
"additionalProperties": {
"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"
},
"description": "User-provided Azure storage accounts.",
"type": "object"
},
"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": "<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.",
"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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.",
"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 <code>ActionHostName</code>.",
"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"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> to enable local MySQL; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"reservedInstanceCount": {
"description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"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"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "<code>true</code> if preloading is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.",
"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": "Move an App Service Environment to a different VNET.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-long-running-operation": true,
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics": {
"get": {
"description": "Get diagnostic information for an App Service Environment.",
"operationId": "AppServiceEnvironments_ListDiagnostics",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"$ref": "#/definitions/HostingEnvironmentDiagnostics"
},
"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": "Get diagnostic information for an App Service Environment.",
"tags": [
"AppServiceEnvironments"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}": {
"get": {
"description": "Get a diagnostics item for an App Service Environment.",
"operationId": "AppServiceEnvironments_GetDiagnosticsItem",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the diagnostics item.",
"in": "path",
"name": "diagnosticsName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/HostingEnvironmentDiagnostics"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 diagnostics item for an App Service Environment.",
"tags": [
"AppServiceEnvironments"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints": {
"get": {
"description": "Get the network endpoints of all inbound dependencies of an App Service Environment.",
"operationId": "AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/InboundEnvironmentEndpointCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 network endpoints of all inbound dependencies of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-examples": {
"Get Inbound Network Dependencies Endpoints": {
"parameters": {
"api-version": "2018-02-01",
"name": "SampleAse",
"resourceGroupName": "Sample-WestUSResourceGroup",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"id": null,
"nextLink": null,
"value": [
{
"description": "App Service management",
"endpoints": [
"70.37.57.58/32",
"157.55.208.185/32",
"23.102.188.65/32",
"191.236.154.88/32",
"52.174.22.21/32",
"13.94.149.179/32",
"13.94.143.126/32",
"13.94.141.115/32",
"52.178.195.197/32",
"52.178.190.65/32",
"52.178.184.149/32",
"52.178.177.147/32",
"13.75.127.117/32",
"40.83.125.161/32",
"40.83.121.56/32",
"40.83.120.64/32",
"52.187.56.50/32",
"52.187.63.37/32",
"52.187.59.251/32",
"52.187.63.19/32",
"52.165.158.140/32",
"52.165.152.214/32",
"52.165.154.193/32",
"52.165.153.122/32",
"104.44.129.255/32",
"104.44.134.255/32",
"104.44.129.243/32",
"104.44.129.141/32",
"65.52.193.203/32",
"70.37.89.222/32",
"13.64.115.203/32",
"52.225.177.153/32",
"65.52.172.237/32"
],
"ports": [
"454",
"455"
]
},
{
"description": "App Service Environment VIP",
"endpoints": [
"52.247.209.18/32"
],
"ports": [
"454",
"455",
"16001"
]
},
{
"description": "App Service Environment subnet",
"endpoints": [
"192.168.250.0/24"
],
"ports": [
"All"
]
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions": {
"get": {
"description": "Get global metric definitions of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListMetricDefinitions",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MetricDefinition"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 global metric definitions of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics": {
"get": {
"description": "Get global metrics of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListMetrics",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Specify <code>true</code> to include instance details. The default is <code>false</code>.",
"in": "query",
"name": "details",
"type": "boolean"
},
{
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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 metric responses.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"description": "Object representing a metric for any resource .",
"properties": {
"endTime": {
"description": "Metric end time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"metricValues": {
"description": "Metric values.",
"items": {
"description": "Value of resource metric.",
"properties": {
"average": {
"description": "Value average.",
"format": "float",
"readOnly": true,
"type": "number"
},
"count": {
"description": "Value count.",
"format": "float",
"readOnly": true,
"type": "number"
},
"maximum": {
"description": "Value maximum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"minimum": {
"description": "Value minimum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"timestamp": {
"description": "Value timestamp.",
"readOnly": true,
"type": "string"
},
"total": {
"description": "Value total.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Name of a metric for any resource .",
"properties": {
"localizedValue": {
"description": "Localized metric name value.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "metric name value.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"resourceId": {
"description": "Metric resource Id.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Metric start time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Metric granularity. E.g PT1H, PT5M, P1D",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Metric unit.",
"readOnly": true,
"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": "Get global metrics of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools": {
"get": {
"description": "Get all multi-role pools.",
"operationId": "AppServiceEnvironments_ListMultiRolePools",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WorkerPoolCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 multi-role pools.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default": {
"get": {
"description": "Get properties of a multi-role pool.",
"operationId": "AppServiceEnvironments_GetMultiRolePool",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 properties of a multi-role pool.",
"tags": [
"AppServiceEnvironments"
]
},
"patch": {
"description": "Create or update a multi-role pool.",
"operationId": "AppServiceEnvironments_UpdateMultiRolePool",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Properties of the multi-role pool.",
"in": "body",
"name": "multiRolePoolEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"400": {
"description": "Bad request."
},
"404": {
"description": "Not found."
},
"409": {
"description": "Conflict."
}
},
"summary": "Create or update a multi-role pool.",
"tags": [
"AppServiceEnvironments"
]
},
"put": {
"description": "Create or update a multi-role pool.",
"operationId": "AppServiceEnvironments_CreateOrUpdateMultiRolePool",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Properties of the multi-role pool.",
"in": "body",
"name": "multiRolePoolEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"400": {
"description": "Bad request."
},
"404": {
"description": "Not found."
},
"409": {
"description": "Conflict."
}
},
"summary": "Create or update a multi-role pool.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions": {
"get": {
"description": "Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the instance in the multi-role pool.",
"in": "path",
"name": "instance",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of metric definitions.",
"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": "Metadata for the metrics.",
"properties": {
"properties": {
"description": "ResourceMetricDefinition resource specific properties",
"properties": {
"metricAvailabilities": {
"description": "List of time grains supported for the metric together with retention period.",
"items": {
"description": "Metrics availability and retention.",
"properties": {
"retention": {
"description": "Retention period for the current time grain.",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Time grain .",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"primaryAggregationType": {
"description": "Primary aggregation type.",
"readOnly": true,
"type": "string"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Resource metric definition properties.",
"readOnly": true,
"type": "object"
},
"resourceUri": {
"description": "Resource URI.",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Unit of the metric.",
"readOnly": true,
"type": "string"
}
},
"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 metric definitions for a specific instance of a multi-role pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics": {
"get": {
"description": "Get metrics for a specific instance of a multi-role pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListMultiRolePoolInstanceMetrics",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the instance in the multi-role pool.",
"in": "path",
"name": "instance",
"required": true,
"type": "string"
},
{
"description": "Specify <code>true</code> to include instance details. The default is <code>false</code>.",
"in": "query",
"name": "details",
"type": "boolean"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of metric responses.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"description": "Object representing a metric for any resource .",
"properties": {
"endTime": {
"description": "Metric end time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"metricValues": {
"description": "Metric values.",
"items": {
"description": "Value of resource metric.",
"properties": {
"average": {
"description": "Value average.",
"format": "float",
"readOnly": true,
"type": "number"
},
"count": {
"description": "Value count.",
"format": "float",
"readOnly": true,
"type": "number"
},
"maximum": {
"description": "Value maximum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"minimum": {
"description": "Value minimum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"timestamp": {
"description": "Value timestamp.",
"readOnly": true,
"type": "string"
},
"total": {
"description": "Value total.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Name of a metric for any resource .",
"properties": {
"localizedValue": {
"description": "Localized metric name value.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "metric name value.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"resourceId": {
"description": "Metric resource Id.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Metric start time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Metric granularity. E.g PT1H, PT5M, P1D",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Metric unit.",
"readOnly": true,
"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": "Get metrics for a specific instance of a multi-role pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions": {
"get": {
"description": "Get metric definitions for a multi-role pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListMultiRoleMetricDefinitions",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of metric definitions.",
"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": "Metadata for the metrics.",
"properties": {
"properties": {
"description": "ResourceMetricDefinition resource specific properties",
"properties": {
"metricAvailabilities": {
"description": "List of time grains supported for the metric together with retention period.",
"items": {
"description": "Metrics availability and retention.",
"properties": {
"retention": {
"description": "Retention period for the current time grain.",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Time grain .",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"primaryAggregationType": {
"description": "Primary aggregation type.",
"readOnly": true,
"type": "string"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Resource metric definition properties.",
"readOnly": true,
"type": "object"
},
"resourceUri": {
"description": "Resource URI.",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Unit of the metric.",
"readOnly": true,
"type": "string"
}
},
"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 metric definitions for a multi-role pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics": {
"get": {
"description": "Get metrics for a multi-role pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListMultiRoleMetrics",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Beginning time of the metrics query.",
"in": "query",
"name": "startTime",
"type": "string"
},
{
"description": "End time of the metrics query.",
"in": "query",
"name": "endTime",
"type": "string"
},
{
"description": "Time granularity of the metrics query.",
"in": "query",
"name": "timeGrain",
"type": "string"
},
{
"description": "Specify <code>true</code> to include instance details. The default is <code>false</code>.",
"in": "query",
"name": "details",
"type": "boolean"
},
{
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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 metric responses.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"description": "Object representing a metric for any resource .",
"properties": {
"endTime": {
"description": "Metric end time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"metricValues": {
"description": "Metric values.",
"items": {
"description": "Value of resource metric.",
"properties": {
"average": {
"description": "Value average.",
"format": "float",
"readOnly": true,
"type": "number"
},
"count": {
"description": "Value count.",
"format": "float",
"readOnly": true,
"type": "number"
},
"maximum": {
"description": "Value maximum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"minimum": {
"description": "Value minimum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"timestamp": {
"description": "Value timestamp.",
"readOnly": true,
"type": "string"
},
"total": {
"description": "Value total.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Name of a metric for any resource .",
"properties": {
"localizedValue": {
"description": "Localized metric name value.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "metric name value.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"resourceId": {
"description": "Metric resource Id.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Metric start time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Metric granularity. E.g PT1H, PT5M, P1D",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Metric unit.",
"readOnly": true,
"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": "Get metrics for a multi-role pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus": {
"get": {
"description": "Get available SKUs for scaling a multi-role pool.",
"operationId": "AppServiceEnvironments_ListMultiRolePoolSkus",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SkuInfoCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 available SKUs for scaling a multi-role pool.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages": {
"get": {
"description": "Get usage metrics for a multi-role pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListMultiRoleUsages",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/UsageCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 usage metrics for a multi-role pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations": {
"get": {
"description": "List all currently running operations on the App Service Environment.",
"operationId": "AppServiceEnvironments_ListOperations",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"items": {
"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"
},
"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": "List all currently running operations on the App Service Environment.",
"tags": [
"AppServiceEnvironments"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints": {
"get": {
"description": "Get the network endpoints of all outbound dependencies of an App Service Environment.",
"operationId": "AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OutboundEnvironmentEndpointCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 network endpoints of all outbound dependencies of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-examples": {
"Get Outbound Network Dependencies Endpoints": {
"parameters": {
"api-version": "2018-02-01",
"name": "SampleAse",
"resourceGroupName": "Sample-WestUSResourceGroup",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"id": null,
"nextLink": null,
"value": [
{
"category": "Azure Storage",
"endpoints": [
{
"domainName": "blob.core.windows.net",
"endpointDetails": [
{
"ipAddress": "52.183.104.36",
"isAccessable": true,
"latency": 42.0469,
"port": 80
},
{
"ipAddress": "52.183.104.36",
"isAccessable": true,
"latency": 41.7038,
"port": 443
}
]
},
{
"domainName": "queue.core.windows.net",
"endpointDetails": [
{
"ipAddress": "52.183.104.25",
"isAccessable": true,
"latency": 37.326,
"port": 80
},
{
"ipAddress": "52.183.104.25",
"isAccessable": true,
"latency": 37.513600000000004,
"port": 443
}
]
},
{
"domainName": "table.core.windows.net",
"endpointDetails": [
{
"ipAddress": "52.183.104.26",
"isAccessable": true,
"latency": 32.789,
"port": 80
},
{
"ipAddress": "52.183.104.26",
"isAccessable": true,
"latency": 1.8702,
"port": 443
}
]
},
{
"domainName": "file.core.windows.net",
"endpointDetails": [
{
"ipAddress": "52.183.104.28",
"isAccessable": true,
"latency": 36.7378,
"port": 80
},
{
"ipAddress": "52.183.104.28",
"isAccessable": true,
"latency": 36.7108,
"port": 443
}
]
},
{
"domainName": "blob.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 4.0261000000000005,
"port": 80
},
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 3.8264,
"port": 443
}
]
},
{
"domainName": "queue.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 40.8523,
"port": 80
},
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 40.7501,
"port": 443
}
]
},
{
"domainName": "table.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 1.2071,
"port": 80
},
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 38.2975,
"port": 443
}
]
},
{
"domainName": "file.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 59.383700000000005,
"port": 80
},
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 60.0775,
"port": 443
}
]
},
{
"domainName": "blob.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 3.5512,
"port": 80
},
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 2.6777,
"port": 443
}
]
},
{
"domainName": "queue.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 3.5204,
"port": 80
},
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 2.8193,
"port": 443
}
]
},
{
"domainName": "table.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 3.2720000000000002,
"port": 80
},
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 3.0147,
"port": 443
}
]
},
{
"domainName": "file.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 3.2387,
"port": 80
},
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 3.2804,
"port": 443
}
]
},
{
"domainName": "blob.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.66.176.16",
"isAccessable": true,
"latency": 43.025200000000005,
"port": 80
},
{
"ipAddress": "13.66.176.16",
"isAccessable": true,
"latency": 43.1683,
"port": 443
}
]
},
{
"domainName": "queue.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.66.176.25",
"isAccessable": true,
"latency": 41.8598,
"port": 80
},
{
"ipAddress": "13.66.176.25",
"isAccessable": true,
"latency": 41.9805,
"port": 443
}
]
},
{
"domainName": "table.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.66.176.26",
"isAccessable": true,
"latency": 30.542900000000003,
"port": 80
},
{
"ipAddress": "13.66.176.26",
"isAccessable": true,
"latency": 0.9832000000000001,
"port": 443
}
]
},
{
"domainName": "file.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.66.176.28",
"isAccessable": true,
"latency": 35.9562,
"port": 80
},
{
"ipAddress": "13.66.176.28",
"isAccessable": true,
"latency": 36.0643,
"port": 443
}
]
},
{
"domainName": "blob.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 3.2829,
"port": 80
},
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 2.3393,
"port": 443
}
]
},
{
"domainName": "queue.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 3.4103000000000003,
"port": 80
},
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 4.1032,
"port": 443
}
]
},
{
"domainName": "table.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 3.1141,
"port": 80
},
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 3.0247,
"port": 443
}
]
},
{
"domainName": "file.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 2.834,
"port": 80
},
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 2.8198000000000003,
"port": 443
}
]
},
{
"domainName": "blob.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 1.3855000000000002,
"port": 80
},
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 1.0594000000000001,
"port": 443
}
]
},
{
"domainName": "queue.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 2.4717000000000002,
"port": 80
},
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 2.4827,
"port": 443
}
]
},
{
"domainName": "table.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 3.395,
"port": 80
},
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 3.1701,
"port": 443
}
]
},
{
"domainName": "file.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 1.4308,
"port": 80
},
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 22.5866,
"port": 443
}
]
},
{
"domainName": "blob.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 2.5372,
"port": 80
},
{
"ipAddress": "13.77.184.64",
"isAccessable": true,
"latency": 2.4626,
"port": 443
}
]
},
{
"domainName": "queue.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 3.7873,
"port": 80
},
{
"ipAddress": "13.77.184.73",
"isAccessable": true,
"latency": 4.1911000000000005,
"port": 443
}
]
},
{
"domainName": "table.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 2.9162000000000003,
"port": 80
},
{
"ipAddress": "13.77.184.74",
"isAccessable": true,
"latency": 2.7896,
"port": 443
}
]
},
{
"domainName": "file.core.windows.net",
"endpointDetails": [
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 26.723100000000002,
"port": 80
},
{
"ipAddress": "13.77.184.76",
"isAccessable": true,
"latency": 26.735200000000003,
"port": 443
}
]
}
]
},
{
"category": "Azure SQL Database",
"endpoints": [
{
"domainName": "database.windows.net",
"endpointDetails": [
{
"ipAddress": "13.66.226.202",
"isAccessable": true,
"latency": 1.5964,
"port": 1433
}
]
}
]
},
{
"category": "Azure Management",
"endpoints": [
{
"domainName": "management.core.windows.net",
"endpointDetails": [
{
"ipAddress": "23.102.135.246",
"isAccessable": true,
"latency": 46.5764,
"port": 443
}
]
},
{
"domainName": "admin.core.windows.net",
"endpointDetails": [
{
"ipAddress": "23.102.135.247",
"isAccessable": true,
"latency": 47.408,
"port": 443
}
]
},
{
"domainName": "management.azure.com",
"endpointDetails": [
{
"ipAddress": "52.151.25.45",
"isAccessable": true,
"latency": 3.9529,
"port": 443
}
]
}
]
},
{
"category": "Azure Active Directory",
"endpoints": [
{
"domainName": "graph.windows.net",
"endpointDetails": [
{
"ipAddress": "20.190.133.83",
"isAccessable": true,
"latency": 3.2264,
"port": 443
},
{
"ipAddress": "20.190.133.81",
"isAccessable": true,
"latency": 3.2264,
"port": 443
},
{
"ipAddress": "20.190.133.67",
"isAccessable": true,
"latency": 3.2264,
"port": 443
},
{
"ipAddress": "40.126.5.34",
"isAccessable": true,
"latency": 3.2264,
"port": 443
}
]
}
]
},
{
"category": "Regional Service",
"endpoints": [
{
"domainName": "gr-prod-mwh.cloudapp.net",
"endpointDetails": [
{
"ipAddress": "13.66.225.188",
"isAccessable": true,
"latency": 3.3826,
"port": 443
}
]
},
{
"domainName": "az-prod.metrics.nsatc.net",
"endpointDetails": [
{
"ipAddress": "40.77.24.27",
"isAccessable": true,
"latency": 38.5647,
"port": 443
}
]
}
]
},
{
"category": "SSL Certificate Verification",
"endpoints": [
{
"domainName": "ocsp.msocsp.com",
"endpointDetails": [
{
"ipAddress": "104.18.25.243",
"isAccessable": true,
"latency": 6.0651,
"port": 80
},
{
"ipAddress": "104.18.25.243",
"isAccessable": true,
"latency": 12.888,
"port": 443
},
{
"ipAddress": "104.18.24.243",
"isAccessable": true,
"latency": 6.0651,
"port": 80
},
{
"ipAddress": "104.18.24.243",
"isAccessable": true,
"latency": 12.888,
"port": 443
}
]
},
{
"domainName": "mscrl.microsoft.com",
"endpointDetails": [
{
"ipAddress": "152.199.4.33",
"isAccessable": true,
"latency": 6.742900000000001,
"port": 80
},
{
"ipAddress": "152.199.4.33",
"isAccessable": true,
"latency": 7.436100000000001,
"port": 443
}
]
},
{
"domainName": "crl.microsoft.com",
"endpointDetails": [
{
"ipAddress": "23.215.102.10",
"isAccessable": true,
"latency": 25.136200000000002,
"port": 80
},
{
"ipAddress": "23.215.102.10",
"isAccessable": true,
"latency": 25.0085,
"port": 443
},
{
"ipAddress": "23.215.102.42",
"isAccessable": true,
"latency": 25.136200000000002,
"port": 80
},
{
"ipAddress": "23.215.102.42",
"isAccessable": true,
"latency": 25.0085,
"port": 443
}
]
},
{
"domainName": "www.microsoft.com",
"endpointDetails": [
{
"ipAddress": "23.49.13.56",
"isAccessable": true,
"latency": 7.9229,
"port": 80
},
{
"ipAddress": "23.49.13.56",
"isAccessable": true,
"latency": 8.4871,
"port": 443
}
]
},
{
"domainName": "crl3.digicert.com",
"endpointDetails": [
{
"ipAddress": "72.21.91.29",
"isAccessable": true,
"latency": 5.4074,
"port": 80
},
{
"ipAddress": "72.21.91.29",
"isAccessable": true,
"latency": 5.577,
"port": 443
}
]
},
{
"domainName": "ocsp.digicert.com",
"endpointDetails": [
{
"ipAddress": "72.21.91.29",
"isAccessable": true,
"latency": 6.8989,
"port": 80
},
{
"ipAddress": "72.21.91.29",
"isAccessable": true,
"latency": 5.667400000000001,
"port": 443
}
]
},
{
"domainName": "cacerts.digicert.com",
"endpointDetails": [
{
"ipAddress": "104.18.11.39",
"isAccessable": true,
"latency": 10.772400000000001,
"port": 80
},
{
"ipAddress": "104.18.11.39",
"isAccessable": true,
"latency": 10.7705,
"port": 443
},
{
"ipAddress": "104.18.10.39",
"isAccessable": true,
"latency": 10.772400000000001,
"port": 80
},
{
"ipAddress": "104.18.10.39",
"isAccessable": true,
"latency": 10.7705,
"port": 443
}
]
},
{
"domainName": "www.thawte.com",
"endpointDetails": [
{
"ipAddress": "54.69.98.161",
"isAccessable": true,
"latency": 47.532900000000005,
"port": 80
},
{
"ipAddress": "54.69.98.161",
"isAccessable": true,
"latency": 48.5362,
"port": 443
},
{
"ipAddress": "35.167.62.148",
"isAccessable": true,
"latency": 47.532900000000005,
"port": 80
},
{
"ipAddress": "35.167.62.148",
"isAccessable": true,
"latency": 48.5362,
"port": 443
}
]
}
]
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": {
"post": {
"description": "Reboot all machines in an App Service Environment.",
"operationId": "AppServiceEnvironments_Reboot",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"202": {
"description": "Asynchronous operation in progress."
},
"400": {
"description": "Bad request."
},
"404": {
"description": "Not found."
},
"409": {
"description": "Conflict."
}
},
"summary": "Reboot all machines in an App Service Environment.",
"tags": [
"AppServiceEnvironments"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume": {
"post": {
"description": "Resume an App Service Environment.",
"operationId": "AppServiceEnvironments_Resume",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"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": [
"SystemAssigned",
"UserAssigned",
"SystemAssigned, UserAssigned",
"None"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"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": "<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.",
"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": "<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "<code>true</code> to clone source control from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "<code>true</code> 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": "<code>true</code> to overwrite destination app; otherwise, <code>false</code>.",
"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": "<code>true</code> if the app is enabled; otherwise, <code>false</code>. 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"
},
"geoDistributions": {
"description": "GeoDistributions for this site",
"items": {
"description": "A global distribution definition.",
"properties": {
"location": {
"description": "Location.",
"type": "string"
},
"numberOfWorkers": {
"description": "NumberOfWorkers.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"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 <code>true</code> 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": "<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.\n If <code>true</code>, 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": "<code>true</code> if the app is a default container; otherwise, <code>false</code>.",
"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. 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": "<code>true</code> if reserved; otherwise, <code>false</code>.",
"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": "<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.",
"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": "<code>true</code> if Always On is enabled; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.",
"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"
},
"azureStorageAccounts": {
"additionalProperties": {
"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"
},
"description": "User-provided Azure storage accounts.",
"type": "object"
},
"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": "<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.",
"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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.",
"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 <code>ActionHostName</code>.",
"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"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> to enable local MySQL; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"reservedInstanceCount": {
"description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"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"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "<code>true</code> if preloading is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.",
"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"
}
},
"202": {
"description": "Operation is in progress.",
"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": [
"SystemAssigned",
"UserAssigned",
"SystemAssigned, UserAssigned",
"None"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"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": "<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.",
"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": "<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "<code>true</code> to clone source control from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "<code>true</code> 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": "<code>true</code> to overwrite destination app; otherwise, <code>false</code>.",
"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": "<code>true</code> if the app is enabled; otherwise, <code>false</code>. 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"
},
"geoDistributions": {
"description": "GeoDistributions for this site",
"items": {
"description": "A global distribution definition.",
"properties": {
"location": {
"description": "Location.",
"type": "string"
},
"numberOfWorkers": {
"description": "NumberOfWorkers.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"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 <code>true</code> 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": "<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.\n If <code>true</code>, 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": "<code>true</code> if the app is a default container; otherwise, <code>false</code>.",
"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. 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": "<code>true</code> if reserved; otherwise, <code>false</code>.",
"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": "<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.",
"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": "<code>true</code> if Always On is enabled; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.",
"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"
},
"azureStorageAccounts": {
"additionalProperties": {
"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"
},
"description": "User-provided Azure storage accounts.",
"type": "object"
},
"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": "<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.",
"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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.",
"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 <code>ActionHostName</code>.",
"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"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> to enable local MySQL; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"reservedInstanceCount": {
"description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"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"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "<code>true</code> if preloading is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.",
"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": "Resume an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-long-running-operation": true,
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms": {
"get": {
"description": "Get all App Service plans in an App Service Environment.",
"operationId": "AppServiceEnvironments_ListAppServicePlans",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of App Service plans.",
"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": "App Service plan.",
"properties": {
"properties": {
"description": "AppServicePlan resource specific properties",
"properties": {
"freeOfferExpirationTime": {
"description": "The time when the server farm free offer expires.",
"format": "date-time",
"type": "string"
},
"geoRegion": {
"description": "Geographical location for the App Service plan.",
"readOnly": true,
"type": "string"
},
"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"
},
"hyperV": {
"default": false,
"description": "If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"isSpot": {
"description": "If <code>true</code>, this App Service Plan owns spot instances.",
"type": "boolean"
},
"isXenon": {
"default": false,
"description": "Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"maximumElasticWorkerCount": {
"description": "Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan",
"format": "int32",
"type": "integer"
},
"maximumNumberOfWorkers": {
"description": "Maximum number of instances that can be assigned to this App Service plan.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"numberOfSites": {
"description": "Number of apps assigned to this App Service plan.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"perSiteScaling": {
"default": false,
"description": "If <code>true</code>, apps assigned to this App Service plan can be scaled independently.\nIf <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.",
"type": "boolean"
},
"provisioningState": {
"description": "Provisioning state of the App Service Environment.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"InProgress",
"Deleting"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ProvisioningState"
}
},
"reserved": {
"default": false,
"description": "If Linux app service plan <code>true</code>, <code>false</code> otherwise.",
"type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"resourceGroup": {
"description": "Resource group of the App Service plan.",
"readOnly": true,
"type": "string"
},
"spotExpirationTime": {
"description": "The time when the server farm expires. Valid only if it is a spot server farm.",
"format": "date-time",
"type": "string"
},
"status": {
"description": "App Service plan status.",
"enum": [
"Ready",
"Pending",
"Creating"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "StatusOptions"
}
},
"subscription": {
"description": "App Service plan subscription.",
"readOnly": true,
"type": "string"
},
"targetWorkerCount": {
"description": "Scaling worker count.",
"format": "int32",
"type": "integer"
},
"targetWorkerSizeId": {
"description": "Scaling worker size ID.",
"format": "int32",
"type": "integer"
},
"workerTierName": {
"description": "Target worker tier assigned to the App Service plan.",
"type": "string"
}
},
"x-ms-client-flatten": true
},
"sku": {
"description": "Description of a SKU for a scalable resource.",
"properties": {
"capabilities": {
"description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
"items": {
"description": "Describes the capabilities/features allowed for a specific SKU.",
"properties": {
"name": {
"description": "Name of the SKU capability.",
"type": "string"
},
"reason": {
"description": "Reason of the SKU capability.",
"type": "string"
},
"value": {
"description": "Value of the SKU capability.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"capacity": {
"description": "Current number of instances assigned to the resource.",
"format": "int32",
"type": "integer"
},
"family": {
"description": "Family code of the resource SKU.",
"type": "string"
},
"locations": {
"description": "Locations of the SKU.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the resource SKU.",
"type": "string"
},
"size": {
"description": "Size specifier of the resource SKU.",
"type": "string"
},
"skuCapacity": {
"description": "Description of the App Service plan scale options.",
"properties": {
"default": {
"description": "Default number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"maximum": {
"description": "Maximum number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"minimum": {
"description": "Minimum number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"scaleType": {
"description": "Available scale configurations for an App Service plan.",
"type": "string"
}
},
"type": "object"
},
"tier": {
"description": "Service tier of the resource SKU.",
"type": "string"
}
},
"type": "object"
}
},
"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 App Service plans in an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites": {
"get": {
"description": "Get all apps in an App Service Environment.",
"operationId": "AppServiceEnvironments_ListWebApps",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Comma separated list of app properties to include.",
"in": "query",
"name": "propertiesToInclude",
"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": [
"SystemAssigned",
"UserAssigned",
"SystemAssigned, UserAssigned",
"None"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"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": "<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.",
"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": "<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "<code>true</code> to clone source control from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "<code>true</code> 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": "<code>true</code> to overwrite destination app; otherwise, <code>false</code>.",
"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": "<code>true</code> if the app is enabled; otherwise, <code>false</code>. 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"
},
"geoDistributions": {
"description": "GeoDistributions for this site",
"items": {
"description": "A global distribution definition.",
"properties": {
"location": {
"description": "Location.",
"type": "string"
},
"numberOfWorkers": {
"description": "NumberOfWorkers.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"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 <code>true</code> 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": "<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.\n If <code>true</code>, 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": "<code>true</code> if the app is a default container; otherwise, <code>false</code>.",
"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. 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": "<code>true</code> if reserved; otherwise, <code>false</code>.",
"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": "<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.",
"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": "<code>true</code> if Always On is enabled; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.",
"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"
},
"azureStorageAccounts": {
"additionalProperties": {
"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"
},
"description": "User-provided Azure storage accounts.",
"type": "object"
},
"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": "<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.",
"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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.",
"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 <code>ActionHostName</code>.",
"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"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> to enable local MySQL; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"reservedInstanceCount": {
"description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"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"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "<code>true</code> if preloading is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.",
"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 in an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend": {
"post": {
"description": "Suspend an App Service Environment.",
"operationId": "AppServiceEnvironments_Suspend",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"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": [
"SystemAssigned",
"UserAssigned",
"SystemAssigned, UserAssigned",
"None"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"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": "<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.",
"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": "<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "<code>true</code> to clone source control from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "<code>true</code> 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": "<code>true</code> to overwrite destination app; otherwise, <code>false</code>.",
"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": "<code>true</code> if the app is enabled; otherwise, <code>false</code>. 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"
},
"geoDistributions": {
"description": "GeoDistributions for this site",
"items": {
"description": "A global distribution definition.",
"properties": {
"location": {
"description": "Location.",
"type": "string"
},
"numberOfWorkers": {
"description": "NumberOfWorkers.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"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 <code>true</code> 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": "<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.\n If <code>true</code>, 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": "<code>true</code> if the app is a default container; otherwise, <code>false</code>.",
"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. 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": "<code>true</code> if reserved; otherwise, <code>false</code>.",
"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": "<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.",
"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": "<code>true</code> if Always On is enabled; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.",
"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"
},
"azureStorageAccounts": {
"additionalProperties": {
"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"
},
"description": "User-provided Azure storage accounts.",
"type": "object"
},
"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": "<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.",
"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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.",
"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 <code>ActionHostName</code>.",
"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"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> to enable local MySQL; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"reservedInstanceCount": {
"description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"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"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "<code>true</code> if preloading is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.",
"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"
}
},
"202": {
"description": "Operation is in progress.",
"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": [
"SystemAssigned",
"UserAssigned",
"SystemAssigned, UserAssigned",
"None"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"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": "<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.",
"type": "boolean"
},
"clientCertEnabled": {
"description": "<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.",
"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": "<code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"cloneSourceControl": {
"description": "<code>true</code> to clone source control from source app; otherwise, <code>false</code>.",
"type": "boolean"
},
"configureLoadBalancing": {
"description": "<code>true</code> 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": "<code>true</code> to overwrite destination app; otherwise, <code>false</code>.",
"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": "<code>true</code> if the app is enabled; otherwise, <code>false</code>. 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"
},
"geoDistributions": {
"description": "GeoDistributions for this site",
"items": {
"description": "A global distribution definition.",
"properties": {
"location": {
"description": "Location.",
"type": "string"
},
"numberOfWorkers": {
"description": "NumberOfWorkers.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"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 <code>true</code> 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": "<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.\n If <code>true</code>, 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": "<code>true</code> if the app is a default container; otherwise, <code>false</code>.",
"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. 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": "<code>true</code> if reserved; otherwise, <code>false</code>.",
"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": "<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.",
"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": "<code>true</code> if Always On is enabled; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.",
"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"
},
"azureStorageAccounts": {
"additionalProperties": {
"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"
},
"description": "User-provided Azure storage accounts.",
"type": "object"
},
"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": "<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.",
"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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.",
"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 <code>ActionHostName</code>.",
"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"
},
"http20Enabled": {
"default": true,
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"type": "boolean"
},
"httpLoggingEnabled": {
"description": "<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> to enable local MySQL; otherwise, <code>false</code>.",
"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"
},
"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": "<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"remoteDebuggingVersion": {
"description": "Remote debugging version.",
"type": "string"
},
"requestTracingEnabled": {
"description": "<code>true</code> if request tracing is enabled; otherwise, <code>false</code>.",
"type": "boolean"
},
"requestTracingExpirationTime": {
"description": "Request tracing expiration time.",
"format": "date-time",
"type": "string"
},
"reservedInstanceCount": {
"description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan",
"format": "int32",
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"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"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScmType"
}
},
"tracingOptions": {
"description": "Tracing options.",
"type": "string"
},
"use32BitWorkerProcess": {
"description": "<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.",
"type": "boolean"
},
"virtualApplications": {
"description": "Virtual applications.",
"items": {
"description": "Virtual application in an app.",
"properties": {
"physicalPath": {
"description": "Physical path.",
"type": "string"
},
"preloadEnabled": {
"description": "<code>true</code> if preloading is enabled; otherwise, <code>false</code>.",
"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": "<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.",
"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": "Suspend an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-long-running-operation": true,
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": {
"get": {
"description": "Get global usage metrics of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListUsages",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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": "Get global usage metrics of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools": {
"get": {
"description": "Get all worker pools of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListWorkerPools",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WorkerPoolCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 worker pools of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}": {
"get": {
"description": "Get properties of a worker pool.",
"operationId": "AppServiceEnvironments_GetWorkerPool",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the worker pool.",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 properties of a worker pool.",
"tags": [
"AppServiceEnvironments"
]
},
"patch": {
"description": "Create or update a worker pool.",
"operationId": "AppServiceEnvironments_UpdateWorkerPool",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the worker pool.",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"description": "Properties of the worker pool.",
"in": "body",
"name": "workerPoolEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"400": {
"description": "Bad request."
},
"404": {
"description": "Not found."
},
"409": {
"description": "Conflict."
}
},
"summary": "Create or update a worker pool.",
"tags": [
"AppServiceEnvironments"
]
},
"put": {
"description": "Create or update a worker pool.",
"operationId": "AppServiceEnvironments_CreateOrUpdateWorkerPool",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the worker pool.",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"description": "Properties of the worker pool.",
"in": "body",
"name": "workerPoolEnvelope",
"required": true,
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"400": {
"description": "Bad request."
},
"404": {
"description": "Not found."
},
"409": {
"description": "Conflict."
}
},
"summary": "Create or update a worker pool.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions": {
"get": {
"description": "Get metric definitions for a specific instance of a worker pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the worker pool.",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"description": "Name of the instance in the worker pool.",
"in": "path",
"name": "instance",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of metric definitions.",
"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": "Metadata for the metrics.",
"properties": {
"properties": {
"description": "ResourceMetricDefinition resource specific properties",
"properties": {
"metricAvailabilities": {
"description": "List of time grains supported for the metric together with retention period.",
"items": {
"description": "Metrics availability and retention.",
"properties": {
"retention": {
"description": "Retention period for the current time grain.",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Time grain .",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"primaryAggregationType": {
"description": "Primary aggregation type.",
"readOnly": true,
"type": "string"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Resource metric definition properties.",
"readOnly": true,
"type": "object"
},
"resourceUri": {
"description": "Resource URI.",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Unit of the metric.",
"readOnly": true,
"type": "string"
}
},
"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 metric definitions for a specific instance of a worker pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics": {
"get": {
"description": "Get metrics for a specific instance of a worker pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListWorkerPoolInstanceMetrics",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the worker pool.",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"description": "Name of the instance in the worker pool.",
"in": "path",
"name": "instance",
"required": true,
"type": "string"
},
{
"description": "Specify <code>true</code> to include instance details. The default is <code>false</code>.",
"in": "query",
"name": "details",
"type": "boolean"
},
{
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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 metric responses.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"description": "Object representing a metric for any resource .",
"properties": {
"endTime": {
"description": "Metric end time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"metricValues": {
"description": "Metric values.",
"items": {
"description": "Value of resource metric.",
"properties": {
"average": {
"description": "Value average.",
"format": "float",
"readOnly": true,
"type": "number"
},
"count": {
"description": "Value count.",
"format": "float",
"readOnly": true,
"type": "number"
},
"maximum": {
"description": "Value maximum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"minimum": {
"description": "Value minimum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"timestamp": {
"description": "Value timestamp.",
"readOnly": true,
"type": "string"
},
"total": {
"description": "Value total.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Name of a metric for any resource .",
"properties": {
"localizedValue": {
"description": "Localized metric name value.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "metric name value.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"resourceId": {
"description": "Metric resource Id.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Metric start time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Metric granularity. E.g PT1H, PT5M, P1D",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Metric unit.",
"readOnly": true,
"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": "Get metrics for a specific instance of a worker pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions": {
"get": {
"description": "Get metric definitions for a worker pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListWebWorkerMetricDefinitions",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the worker pool.",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"description": "Collection of metric definitions.",
"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": "Metadata for the metrics.",
"properties": {
"properties": {
"description": "ResourceMetricDefinition resource specific properties",
"properties": {
"metricAvailabilities": {
"description": "List of time grains supported for the metric together with retention period.",
"items": {
"description": "Metrics availability and retention.",
"properties": {
"retention": {
"description": "Retention period for the current time grain.",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Time grain .",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"primaryAggregationType": {
"description": "Primary aggregation type.",
"readOnly": true,
"type": "string"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Resource metric definition properties.",
"readOnly": true,
"type": "object"
},
"resourceUri": {
"description": "Resource URI.",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Unit of the metric.",
"readOnly": true,
"type": "string"
}
},
"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 metric definitions for a worker pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics": {
"get": {
"description": "Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).",
"operationId": "AppServiceEnvironments_ListWebWorkerMetrics",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of worker pool",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"description": "Specify <code>true</code> to include instance details. The default is <code>false</code>.",
"in": "query",
"name": "details",
"type": "boolean"
},
{
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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 metric responses.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"description": "Object representing a metric for any resource .",
"properties": {
"endTime": {
"description": "Metric end time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Resource Id.",
"readOnly": true,
"type": "string"
},
"metricValues": {
"description": "Metric values.",
"items": {
"description": "Value of resource metric.",
"properties": {
"average": {
"description": "Value average.",
"format": "float",
"readOnly": true,
"type": "number"
},
"count": {
"description": "Value count.",
"format": "float",
"readOnly": true,
"type": "number"
},
"maximum": {
"description": "Value maximum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"minimum": {
"description": "Value minimum.",
"format": "float",
"readOnly": true,
"type": "number"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"timestamp": {
"description": "Value timestamp.",
"readOnly": true,
"type": "string"
},
"total": {
"description": "Value total.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Name of a metric for any resource .",
"properties": {
"localizedValue": {
"description": "Localized metric name value.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "metric name value.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"properties": {
"description": "Resource metric properties collection.",
"items": {
"description": "Resource metric property.",
"properties": {
"key": {
"description": "Key for resource metric property.",
"type": "string"
},
"value": {
"description": "Value of pair.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"resourceId": {
"description": "Metric resource Id.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Metric start time.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"timeGrain": {
"description": "Metric granularity. E.g PT1H, PT5M, P1D",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Metric unit.",
"readOnly": true,
"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": "Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus": {
"get": {
"description": "Get available SKUs for scaling a worker pool.",
"operationId": "AppServiceEnvironments_ListWorkerPoolSkus",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the worker pool.",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SkuInfoCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 available SKUs for scaling a worker pool.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages": {
"get": {
"description": "Get usage metrics for a worker pool of an App Service Environment.",
"operationId": "AppServiceEnvironments_ListWebWorkerUsages",
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"description": "Name of the App Service Environment.",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "Name of the worker pool.",
"in": "path",
"name": "workerPoolName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/UsageCollection"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"description": "App Service error response.",
"properties": {
"error": {
"description": "Error model.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"details": {
"items": {
"description": "Detailed errors.",
"properties": {
"code": {
"description": "Standardized string to programmatically identify the error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Detailed error description and debugging information.",
"readOnly": true,
"type": "string"
}
},
"readOnly": true
},
"type": "array"
},
"innererror": {
"description": "More information to debug error.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Detailed error description and debugging 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 usage metrics for a worker pool of an App Service Environment.",
"tags": [
"AppServiceEnvironments"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"AddressResponse": {
"description": "Describes main public IP address and any extra virtual IPs.",
"properties": {
"internalIpAddress": {
"description": "Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode.",
"type": "string"
},
"outboundIpAddresses": {
"description": "IP addresses appearing on outbound connections.",
"items": {
"type": "string"
},
"type": "array"
},
"serviceIpAddress": {
"description": "Main public virtual IP.",
"type": "string"
},
"vipMappings": {
"description": "Additional virtual IPs.",
"items": {
"description": "Virtual IP mapping.",
"properties": {
"inUse": {
"description": "Is virtual IP mapping in use.",
"type": "boolean"
},
"internalHttpPort": {
"description": "Internal HTTP port.",
"format": "int32",
"type": "integer"
},
"internalHttpsPort": {
"description": "Internal HTTPS port.",
"format": "int32",
"type": "integer"
},
"virtualIP": {
"description": "Virtual IP address.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"AppServiceEnvironmentCollection": {
"description": "Collection of App Service Environments.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"AppServiceEnvironmentPatchResource": {
"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 app service environment.",
"properties": {
"properties": {
"description": "Description of an App Service Environment.",
"properties": {
"allowedMultiSizes": {
"description": "List of comma separated strings describing which VM sizes are allowed for front-ends.",
"readOnly": true,
"type": "string"
},
"allowedWorkerSizes": {
"description": "List of comma separated strings describing which VM sizes are allowed for workers.",
"readOnly": true,
"type": "string"
},
"apiManagementAccountId": {
"description": "API Management Account associated with the App Service Environment.",
"type": "string"
},
"clusterSettings": {
"description": "Custom settings for changing the behavior of the App Service Environment.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"databaseEdition": {
"description": "Edition of the metadata database for the App Service Environment, e.g. \"Standard\".",
"readOnly": true,
"type": "string"
},
"databaseServiceObjective": {
"description": "Service objective of the metadata database for the App Service Environment, e.g. \"S0\".",
"readOnly": true,
"type": "string"
},
"defaultFrontEndScaleFactor": {
"description": "Default Scale Factor for FrontEnds.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"dnsSuffix": {
"description": "DNS suffix of the App Service Environment.",
"type": "string"
},
"dynamicCacheEnabled": {
"description": "True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).",
"type": "boolean"
},
"environmentCapacities": {
"description": "Current total, used, and available worker capacities.",
"items": {
"description": "Stamp capacity information.",
"properties": {
"availableCapacity": {
"description": "Available capacity (# of machines, bytes of storage etc...).",
"format": "int64",
"type": "integer"
},
"computeMode": {
"description": "Shared/dedicated workers.",
"enum": [
"Shared",
"Dedicated",
"Dynamic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ComputeModeOptions"
}
},
"excludeFromCapacityAllocation": {
"description": "If <code>true</code>, it includes basic apps.\nBasic apps are not used for capacity allocation.",
"type": "boolean"
},
"isApplicableForAllComputeModes": {
"description": "<code>true</code> if capacity is applicable for all apps; otherwise, <code>false</code>.",
"type": "boolean"
},
"isLinux": {
"description": "Is this a linux stamp capacity",
"type": "boolean"
},
"name": {
"description": "Name of the stamp.",
"type": "string"
},
"siteMode": {
"description": "Shared or Dedicated.",
"type": "string"
},
"totalCapacity": {
"description": "Total capacity (# of machines, bytes of storage etc...).",
"format": "int64",
"type": "integer"
},
"unit": {
"description": "Name of the unit.",
"type": "string"
},
"workerSize": {
"description": "Size of the machines.",
"enum": [
"Small",
"Medium",
"Large",
"D1",
"D2",
"D3",
"Default"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "WorkerSizeOptions"
}
},
"workerSizeId": {
"description": "Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"environmentIsHealthy": {
"description": "True/false indicating whether the App Service Environment is healthy.",
"readOnly": true,
"type": "boolean"
},
"environmentStatus": {
"description": "Detailed message about with results of the last check of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"frontEndScaleFactor": {
"description": "Scale factor for front-ends.",
"format": "int32",
"type": "integer"
},
"hasLinuxWorkers": {
"description": "Flag that displays whether an ASE has linux workers or not",
"type": "boolean"
},
"internalLoadBalancingMode": {
"description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.",
"enum": [
"None",
"Web",
"Publishing"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "InternalLoadBalancingMode"
}
},
"ipsslAddressCount": {
"description": "Number of IP SSL addresses reserved for the App Service Environment.",
"format": "int32",
"type": "integer"
},
"lastAction": {
"description": "Last deployment action on the App Service Environment.",
"readOnly": true,
"type": "string"
},
"lastActionResult": {
"description": "Result of the last deployment action on the App Service Environment.",
"readOnly": true,
"type": "string"
},
"location": {
"description": "Location of the App Service Environment, e.g. \"West US\".",
"type": "string"
},
"maximumNumberOfMachines": {
"description": "Maximum number of VMs in the App Service Environment.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"multiRoleCount": {
"description": "Number of front-end instances.",
"format": "int32",
"type": "integer"
},
"multiSize": {
"description": "Front-end VM size, e.g. \"Medium\", \"Large\".",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"type": "string"
},
"networkAccessControlList": {
"description": "Access control list for controlling traffic to the App Service Environment.",
"items": {
"description": "Network access control entry.",
"properties": {
"action": {
"description": "Action object.",
"enum": [
"Permit",
"Deny"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AccessControlEntryAction"
}
},
"description": {
"description": "Description of network access control entry.",
"type": "string"
},
"order": {
"description": "Order of precedence.",
"format": "int32",
"type": "integer"
},
"remoteSubnet": {
"description": "Remote subnet.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"provisioningState": {
"description": "Provisioning state of the App Service Environment.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"InProgress",
"Deleting"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ProvisioningState"
}
},
"resourceGroup": {
"description": "Resource group of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"sslCertKeyVaultId": {
"description": "Key Vault ID for ILB App Service Environment default SSL certificate",
"type": "string"
},
"sslCertKeyVaultSecretName": {
"description": "Key Vault Secret Name for ILB App Service Environment default SSL certificate",
"type": "string"
},
"status": {
"description": "Current status of the App Service Environment.",
"enum": [
"Preparing",
"Ready",
"Scaling",
"Deleting"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostingEnvironmentStatus"
}
},
"subscriptionId": {
"description": "Subscription of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"suspended": {
"description": "<code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available\n (most likely because NSG blocked the incoming traffic).",
"type": "boolean"
},
"upgradeDomains": {
"description": "Number of upgrade domains of the App Service Environment.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"items": {
"type": "string"
},
"type": "array"
},
"vipMappings": {
"description": "Description of IP SSL mapping for the App Service Environment.",
"items": {
"description": "Virtual IP mapping.",
"properties": {
"inUse": {
"description": "Is virtual IP mapping in use.",
"type": "boolean"
},
"internalHttpPort": {
"description": "Internal HTTP port.",
"format": "int32",
"type": "integer"
},
"internalHttpsPort": {
"description": "Internal HTTPS port.",
"format": "int32",
"type": "integer"
},
"virtualIP": {
"description": "Virtual IP address.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"virtualNetwork": {
"description": "Specification for using a Virtual Network.",
"properties": {
"id": {
"description": "Resource id of the Virtual Network.",
"type": "string"
},
"name": {
"description": "Name of the Virtual Network (read-only).",
"readOnly": true,
"type": "string"
},
"subnet": {
"description": "Subnet within the Virtual Network.",
"type": "string"
},
"type": {
"description": "Resource type of the Virtual Network (read-only).",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"vnetName": {
"description": "Name of the Virtual Network for the App Service Environment.",
"type": "string"
},
"vnetResourceGroupName": {
"description": "Resource group of the Virtual Network.",
"type": "string"
},
"vnetSubnetName": {
"description": "Subnet of the Virtual Network.",
"type": "string"
},
"workerPools": {
"description": "Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.",
"items": {
"description": "Worker pool of an App Service Environment.",
"properties": {
"computeMode": {
"description": "Shared or dedicated app hosting.",
"enum": [
"Shared",
"Dedicated",
"Dynamic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ComputeModeOptions"
}
},
"instanceNames": {
"description": "Names of all instances in the worker pool (read only).",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"workerCount": {
"description": "Number of instances in the worker pool.",
"format": "int32",
"type": "integer"
},
"workerSize": {
"description": "VM size of the worker pool instances.",
"type": "string"
},
"workerSizeId": {
"description": "Worker size ID for referencing this worker pool.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"location",
"virtualNetwork",
"workerPools"
],
"type": "object"
}
},
"type": "object"
},
"AppServiceEnvironmentResource": {
"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": "App Service Environment ARM resource.",
"properties": {
"properties": {
"description": "Description of an App Service Environment.",
"properties": {
"allowedMultiSizes": {
"description": "List of comma separated strings describing which VM sizes are allowed for front-ends.",
"readOnly": true,
"type": "string"
},
"allowedWorkerSizes": {
"description": "List of comma separated strings describing which VM sizes are allowed for workers.",
"readOnly": true,
"type": "string"
},
"apiManagementAccountId": {
"description": "API Management Account associated with the App Service Environment.",
"type": "string"
},
"clusterSettings": {
"description": "Custom settings for changing the behavior of the App Service Environment.",
"items": {
"description": "Name value pair.",
"properties": {
"name": {
"description": "Pair name.",
"type": "string"
},
"value": {
"description": "Pair value.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"databaseEdition": {
"description": "Edition of the metadata database for the App Service Environment, e.g. \"Standard\".",
"readOnly": true,
"type": "string"
},
"databaseServiceObjective": {
"description": "Service objective of the metadata database for the App Service Environment, e.g. \"S0\".",
"readOnly": true,
"type": "string"
},
"defaultFrontEndScaleFactor": {
"description": "Default Scale Factor for FrontEnds.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"dnsSuffix": {
"description": "DNS suffix of the App Service Environment.",
"type": "string"
},
"dynamicCacheEnabled": {
"description": "True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).",
"type": "boolean"
},
"environmentCapacities": {
"description": "Current total, used, and available worker capacities.",
"items": {
"description": "Stamp capacity information.",
"properties": {
"availableCapacity": {
"description": "Available capacity (# of machines, bytes of storage etc...).",
"format": "int64",
"type": "integer"
},
"computeMode": {
"description": "Shared/dedicated workers.",
"enum": [
"Shared",
"Dedicated",
"Dynamic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ComputeModeOptions"
}
},
"excludeFromCapacityAllocation": {
"description": "If <code>true</code>, it includes basic apps.\nBasic apps are not used for capacity allocation.",
"type": "boolean"
},
"isApplicableForAllComputeModes": {
"description": "<code>true</code> if capacity is applicable for all apps; otherwise, <code>false</code>.",
"type": "boolean"
},
"isLinux": {
"description": "Is this a linux stamp capacity",
"type": "boolean"
},
"name": {
"description": "Name of the stamp.",
"type": "string"
},
"siteMode": {
"description": "Shared or Dedicated.",
"type": "string"
},
"totalCapacity": {
"description": "Total capacity (# of machines, bytes of storage etc...).",
"format": "int64",
"type": "integer"
},
"unit": {
"description": "Name of the unit.",
"type": "string"
},
"workerSize": {
"description": "Size of the machines.",
"enum": [
"Small",
"Medium",
"Large",
"D1",
"D2",
"D3",
"Default"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "WorkerSizeOptions"
}
},
"workerSizeId": {
"description": "Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"environmentIsHealthy": {
"description": "True/false indicating whether the App Service Environment is healthy.",
"readOnly": true,
"type": "boolean"
},
"environmentStatus": {
"description": "Detailed message about with results of the last check of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"frontEndScaleFactor": {
"description": "Scale factor for front-ends.",
"format": "int32",
"type": "integer"
},
"hasLinuxWorkers": {
"description": "Flag that displays whether an ASE has linux workers or not",
"type": "boolean"
},
"internalLoadBalancingMode": {
"description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.",
"enum": [
"None",
"Web",
"Publishing"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "InternalLoadBalancingMode"
}
},
"ipsslAddressCount": {
"description": "Number of IP SSL addresses reserved for the App Service Environment.",
"format": "int32",
"type": "integer"
},
"lastAction": {
"description": "Last deployment action on the App Service Environment.",
"readOnly": true,
"type": "string"
},
"lastActionResult": {
"description": "Result of the last deployment action on the App Service Environment.",
"readOnly": true,
"type": "string"
},
"location": {
"description": "Location of the App Service Environment, e.g. \"West US\".",
"type": "string"
},
"maximumNumberOfMachines": {
"description": "Maximum number of VMs in the App Service Environment.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"multiRoleCount": {
"description": "Number of front-end instances.",
"format": "int32",
"type": "integer"
},
"multiSize": {
"description": "Front-end VM size, e.g. \"Medium\", \"Large\".",
"type": "string"
},
"name": {
"description": "Name of the App Service Environment.",
"type": "string"
},
"networkAccessControlList": {
"description": "Access control list for controlling traffic to the App Service Environment.",
"items": {
"description": "Network access control entry.",
"properties": {
"action": {
"description": "Action object.",
"enum": [
"Permit",
"Deny"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AccessControlEntryAction"
}
},
"description": {
"description": "Description of network access control entry.",
"type": "string"
},
"order": {
"description": "Order of precedence.",
"format": "int32",
"type": "integer"
},
"remoteSubnet": {
"description": "Remote subnet.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"provisioningState": {
"description": "Provisioning state of the App Service Environment.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"InProgress",
"Deleting"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ProvisioningState"
}
},
"resourceGroup": {
"description": "Resource group of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"sslCertKeyVaultId": {
"description": "Key Vault ID for ILB App Service Environment default SSL certificate",
"type": "string"
},
"sslCertKeyVaultSecretName": {
"description": "Key Vault Secret Name for ILB App Service Environment default SSL certificate",
"type": "string"
},
"status": {
"description": "Current status of the App Service Environment.",
"enum": [
"Preparing",
"Ready",
"Scaling",
"Deleting"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "HostingEnvironmentStatus"
}
},
"subscriptionId": {
"description": "Subscription of the App Service Environment.",
"readOnly": true,
"type": "string"
},
"suspended": {
"description": "<code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available\n (most likely because NSG blocked the incoming traffic).",
"type": "boolean"
},
"upgradeDomains": {
"description": "Number of upgrade domains of the App Service Environment.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"items": {
"type": "string"
},
"type": "array"
},
"vipMappings": {
"description": "Description of IP SSL mapping for the App Service Environment.",
"items": {
"description": "Virtual IP mapping.",
"properties": {
"inUse": {
"description": "Is virtual IP mapping in use.",
"type": "boolean"
},
"internalHttpPort": {
"description": "Internal HTTP port.",
"format": "int32",
"type": "integer"
},
"internalHttpsPort": {
"description": "Internal HTTPS port.",
"format": "int32",
"type": "integer"
},
"virtualIP": {
"description": "Virtual IP address.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"virtualNetwork": {
"description": "Specification for using a Virtual Network.",
"properties": {
"id": {
"description": "Resource id of the Virtual Network.",
"type": "string"
},
"name": {
"description": "Name of the Virtual Network (read-only).",
"readOnly": true,
"type": "string"
},
"subnet": {
"description": "Subnet within the Virtual Network.",
"type": "string"
},
"type": {
"description": "Resource type of the Virtual Network (read-only).",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"vnetName": {
"description": "Name of the Virtual Network for the App Service Environment.",
"type": "string"
},
"vnetResourceGroupName": {
"description": "Resource group of the Virtual Network.",
"type": "string"
},
"vnetSubnetName": {
"description": "Subnet of the Virtual Network.",
"type": "string"
},
"workerPools": {
"description": "Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.",
"items": {
"description": "Worker pool of an App Service Environment.",
"properties": {
"computeMode": {
"description": "Shared or dedicated app hosting.",
"enum": [
"Shared",
"Dedicated",
"Dynamic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ComputeModeOptions"
}
},
"instanceNames": {
"description": "Names of all instances in the worker pool (read only).",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"workerCount": {
"description": "Number of instances in the worker pool.",
"format": "int32",
"type": "integer"
},
"workerSize": {
"description": "VM size of the worker pool instances.",
"type": "string"
},
"workerSizeId": {
"description": "Worker size ID for referencing this worker pool.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"location",
"virtualNetwork",
"workerPools"
],
"type": "object"
}
},
"type": "object"
},
"EndpointDependency": {
"description": "A domain name that a service is reached at, including details of the current connection status.",
"properties": {
"domainName": {
"description": "The domain name of the dependency.",
"type": "string"
},
"endpointDetails": {
"description": "The IP Addresses and Ports used when connecting to DomainName.",
"items": {
"$ref": "#/definitions/EndpointDetail"
},
"type": "array"
}
},
"type": "object"
},
"EndpointDetail": {
"description": "Current TCP connectivity information from the App Service Environment to a single endpoint.",
"properties": {
"ipAddress": {
"description": "An IP Address that Domain Name currently resolves to.",
"type": "string"
},
"isAccessable": {
"description": "Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port.",
"type": "boolean"
},
"latency": {
"description": "The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port.",
"format": "double",
"type": "number"
},
"port": {
"description": "The port an endpoint is connected to.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ErrorEntity": {},
"HostingEnvironmentDiagnostics": {
"description": "Diagnostics for an App Service Environment.",
"properties": {
"diagnosicsOutput": {
"description": "Diagnostics output.",
"type": "string"
},
"name": {
"description": "Name/identifier of the diagnostics.",
"type": "string"
}
},
"type": "object"
},
"InboundEnvironmentEndpoint": {
"description": "The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.",
"properties": {
"description": {
"description": "Short text describing the purpose of the network traffic.",
"type": "string"
},
"endpoints": {
"description": "The IP addresses that network traffic will originate from in cidr notation.",
"items": {
"type": "string"
},
"type": "array"
},
"ports": {
"description": "The ports that network traffic will arrive to the App Service Environment at.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InboundEnvironmentEndpointCollection": {
"description": "Collection of Inbound Environment Endpoints",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/InboundEnvironmentEndpoint"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"MetricAvailabilily": {
"description": "Metric availability and retention.",
"properties": {
"retention": {
"description": "Retention period for the current time grain.",
"type": "string"
},
"timeGrain": {
"description": "Time grain.",
"type": "string"
}
},
"type": "object"
},
"MetricDefinition": {
"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": "Metadata for a metric.",
"properties": {
"properties": {
"description": "MetricDefinition resource specific properties",
"properties": {
"displayName": {
"description": "Friendly name shown in the UI.",
"readOnly": true,
"type": "string"
},
"metricAvailabilities": {
"description": "List of time grains supported for the metric together with retention period.",
"items": {
"$ref": "#/definitions/MetricAvailabilily"
},
"readOnly": true,
"type": "array"
},
"primaryAggregationType": {
"description": "Primary aggregation type.",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Unit of the metric.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"OutboundEnvironmentEndpoint": {
"description": "Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.",
"properties": {
"category": {
"description": "The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.",
"type": "string"
},
"endpoints": {
"description": "The endpoints that the App Service Environment reaches the service at.",
"items": {
"$ref": "#/definitions/EndpointDependency"
},
"type": "array"
}
},
"type": "object"
},
"OutboundEnvironmentEndpointCollection": {
"description": "Collection of Outbound Environment Endpoints",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/OutboundEnvironmentEndpoint"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"SkuInfo": {
"description": "SKU discovery information.",
"properties": {
"capacity": {
"description": "Description of the App Service plan scale options.",
"properties": {
"default": {
"description": "Default number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"maximum": {
"description": "Maximum number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"minimum": {
"description": "Minimum number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"scaleType": {
"description": "Available scale configurations for an App Service plan.",
"type": "string"
}
},
"type": "object"
},
"resourceType": {
"description": "Resource type that this SKU applies to.",
"type": "string"
},
"sku": {
"description": "Description of a SKU for a scalable resource.",
"properties": {
"capabilities": {
"description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
"items": {
"description": "Describes the capabilities/features allowed for a specific SKU.",
"properties": {
"name": {
"description": "Name of the SKU capability.",
"type": "string"
},
"reason": {
"description": "Reason of the SKU capability.",
"type": "string"
},
"value": {
"description": "Value of the SKU capability.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"capacity": {
"description": "Current number of instances assigned to the resource.",
"format": "int32",
"type": "integer"
},
"family": {
"description": "Family code of the resource SKU.",
"type": "string"
},
"locations": {
"description": "Locations of the SKU.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the resource SKU.",
"type": "string"
},
"size": {
"description": "Size specifier of the resource SKU.",
"type": "string"
},
"skuCapacity": {
"description": "Description of the App Service plan scale options.",
"properties": {
"default": {
"description": "Default number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"maximum": {
"description": "Maximum number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"minimum": {
"description": "Minimum number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"scaleType": {
"description": "Available scale configurations for an App Service plan.",
"type": "string"
}
},
"type": "object"
},
"tier": {
"description": "Service tier of the resource SKU.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SkuInfoCollection": {
"description": "Collection of SKU information.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/SkuInfo"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"StampCapacityCollection": {
"description": "Collection of stamp capacities.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"description": "Stamp capacity information.",
"properties": {
"availableCapacity": {
"description": "Available capacity (# of machines, bytes of storage etc...).",
"format": "int64",
"type": "integer"
},
"computeMode": {
"description": "Shared/dedicated workers.",
"enum": [
"Shared",
"Dedicated",
"Dynamic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ComputeModeOptions"
}
},
"excludeFromCapacityAllocation": {
"description": "If <code>true</code>, it includes basic apps.\nBasic apps are not used for capacity allocation.",
"type": "boolean"
},
"isApplicableForAllComputeModes": {
"description": "<code>true</code> if capacity is applicable for all apps; otherwise, <code>false</code>.",
"type": "boolean"
},
"isLinux": {
"description": "Is this a linux stamp capacity",
"type": "boolean"
},
"name": {
"description": "Name of the stamp.",
"type": "string"
},
"siteMode": {
"description": "Shared or Dedicated.",
"type": "string"
},
"totalCapacity": {
"description": "Total capacity (# of machines, bytes of storage etc...).",
"format": "int64",
"type": "integer"
},
"unit": {
"description": "Name of the unit.",
"type": "string"
},
"workerSize": {
"description": "Size of the machines.",
"enum": [
"Small",
"Medium",
"Large",
"D1",
"D2",
"D3",
"Default"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "WorkerSizeOptions"
}
},
"workerSizeId": {
"description": "Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"Usage": {
"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": "Usage of the quota resource.",
"properties": {
"properties": {
"description": "Usage resource specific properties",
"properties": {
"computeMode": {
"description": "Compute mode used for this usage.",
"enum": [
"Shared",
"Dedicated",
"Dynamic"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ComputeModeOptions"
}
},
"currentValue": {
"description": "The current value of the resource counter.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"displayName": {
"description": "Friendly name shown in the UI.",
"readOnly": true,
"type": "string"
},
"limit": {
"description": "The resource limit.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"nextResetTime": {
"description": "Next reset time for the resource counter.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"resourceName": {
"description": "Name of the quota resource.",
"readOnly": true,
"type": "string"
},
"siteMode": {
"description": "Site mode used for this usage.",
"readOnly": true,
"type": "string"
},
"unit": {
"description": "Units of measurement for the quota resource.",
"readOnly": true,
"type": "string"
}
},
"x-ms-client-flatten": true
}
},
"type": "object"
},
"UsageCollection": {
"description": "Collection of usages.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/Usage"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"WorkerPoolCollection": {
"description": "Collection of worker pools.",
"properties": {
"nextLink": {
"description": "Link to next page of resources.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/WorkerPoolResource"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"WorkerPoolResource": {
"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": "Worker pool of an App Service Environment ARM resource.",
"properties": {
"properties": {
"description": "Worker pool of an App Service Environment.",
"properties": {
"computeMode": {
"description": "Shared or dedicated app hosting.",
"enum": [
"Shared",
"Dedicated",
"Dynamic"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ComputeModeOptions"
}
},
"instanceNames": {
"description": "Names of all instances in the worker pool (read only).",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"workerCount": {
"description": "Number of instances in the worker pool.",
"format": "int32",
"type": "integer"
},
"workerSize": {
"description": "VM size of the worker pool instances.",
"type": "string"
},
"workerSizeId": {
"description": "Worker size ID for referencing this worker pool.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"sku": {
"description": "Description of a SKU for a scalable resource.",
"properties": {
"capabilities": {
"description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
"items": {
"description": "Describes the capabilities/features allowed for a specific SKU.",
"properties": {
"name": {
"description": "Name of the SKU capability.",
"type": "string"
},
"reason": {
"description": "Reason of the SKU capability.",
"type": "string"
},
"value": {
"description": "Value of the SKU capability.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"capacity": {
"description": "Current number of instances assigned to the resource.",
"format": "int32",
"type": "integer"
},
"family": {
"description": "Family code of the resource SKU.",
"type": "string"
},
"locations": {
"description": "Locations of the SKU.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the resource SKU.",
"type": "string"
},
"size": {
"description": "Size specifier of the resource SKU.",
"type": "string"
},
"skuCapacity": {
"description": "Description of the App Service plan scale options.",
"properties": {
"default": {
"description": "Default number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"maximum": {
"description": "Maximum number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"minimum": {
"description": "Minimum number of workers for this App Service plan SKU.",
"format": "int32",
"type": "integer"
},
"scaleType": {
"description": "Available scale configurations for an App Service plan.",
"type": "string"
}
},
"type": "object"
},
"tier": {
"description": "Service tier of the resource SKU.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}