diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json index dab6c56541f2..e8d5a48ab8aa 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json @@ -539,13 +539,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundnetworkdependenciesendpoints": { "get": { "tags": [ "AppServiceEnvironments" ], - "summary": "Get the network endpoints of all inbound dependencies of an App Service Environment.", - "description": "Get the network endpoints of all inbound dependencies of an App Service Environment.", + "summary": "Get the network endpoints of all inbound dependencies of an ase.", + "description": "Get the network endpoints of all inbound dependencies of an ase.", "operationId": "AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints", "parameters": [ { @@ -569,7 +569,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/InboundEnvironmentEndpointCollection" + "type": "array", + "items": { + "$ref": "#/definitions/InboundEnvironmentEndpoint" + } } }, "default": { @@ -578,14 +581,6 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-examples": { - "Get Inbound Network Dependencies Endpoints": { - "$ref": "./examples/GetInboundNetworkDependenciesEndpoints.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, @@ -1259,13 +1254,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundnetworkdependenciesendpoints": { "get": { "tags": [ "AppServiceEnvironments" ], - "summary": "Get the network endpoints of all outbound dependencies of an App Service Environment.", - "description": "Get the network endpoints of all outbound dependencies of an App Service Environment.", + "summary": "Get the network endpoints of all outbound dependencies of an ase.", + "description": "Get the network endpoints of all outbound dependencies of an ase.", "operationId": "AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints", "parameters": [ { @@ -1289,7 +1284,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + } } }, "default": { @@ -1298,14 +1296,6 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-examples": { - "Get Outbound Network Dependencies Endpoints": { - "$ref": "./examples/GetOutboundNetworkDependenciesEndpoints.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, @@ -2264,11 +2254,10 @@ } }, "EndpointDependency": { - "description": "A domain name that a service is reached at, including details of the current connection status.", "type": "object", "properties": { "domainName": { - "description": "The domain name of the dependency.", + "description": "The Domain Name of the dependency.", "type": "string" }, "endpointDetails": { @@ -2281,7 +2270,6 @@ } }, "EndpointDetail": { - "description": "Current TCP connectivity information from the App Service Environment to a single endpoint.", "type": "object", "properties": { "ipAddress": { @@ -2295,11 +2283,11 @@ }, "latency": { "format": "double", - "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.", + "description": "The time in milliseconds it takes to connect to this IpAddress at this Port.", "type": "number" }, "isAccessable": { - "description": "Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port.", + "description": "Whether it is possible to connect to IpAddress.", "type": "boolean" } } @@ -2319,22 +2307,22 @@ } }, "InboundEnvironmentEndpoint": { - "description": "The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.", + "description": "Endpoints for a particular type", "type": "object", "properties": { "description": { - "description": "Short text describing the purpose of the network traffic.", + "description": "Text describing the endpoints.", "type": "string" }, "endpoints": { - "description": "The IP addresses that network traffic will originate from in cidr notation.", + "description": "The endpoint ip addresses in cidr notation.", "type": "array", "items": { "type": "string" } }, "ports": { - "description": "The ports that network traffic will arrive to the App Service Environment at.", + "description": "The ports", "type": "array", "items": { "type": "string" @@ -2342,27 +2330,6 @@ } } }, - "InboundEnvironmentEndpointCollection": { - "description": "Collection of Inbound Environment Endpoints", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "Collection of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/InboundEnvironmentEndpoint" - } - }, - "nextLink": { - "description": "Link to next page of resources.", - "type": "string", - "readOnly": true - } - } - }, "MetricAvailabilily": { "description": "Metric availability and retention.", "type": "object", @@ -2418,15 +2385,15 @@ } }, "OutboundEnvironmentEndpoint": { - "description": "Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.", + "description": "Endpoints of a common type.", "type": "object", "properties": { "category": { - "description": "The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.", + "description": "Short description of the endpoints.", "type": "string" }, "endpoints": { - "description": "The endpoints that the App Service Environment reaches the service at.", + "description": "The endpoint's domain name and the IP Addresses it currently resolves to.", "type": "array", "items": { "$ref": "#/definitions/EndpointDependency" @@ -2434,27 +2401,6 @@ } } }, - "OutboundEnvironmentEndpointCollection": { - "description": "Collection of Outbound Environment Endpoints", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "Collection of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/OutboundEnvironmentEndpoint" - } - }, - "nextLink": { - "description": "Link to next page of resources.", - "type": "string", - "readOnly": true - } - } - }, "SkuInfo": { "description": "SKU discovery information.", "type": "object", @@ -2691,4 +2637,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json index 64c86ee3043d..99da8701c92d 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json @@ -188,12 +188,6 @@ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan" } }, - "201": { - "description": "Created.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan" - } - }, "202": { "description": "Operation is in progress.", "schema": { @@ -1763,4 +1757,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ClassicMobileServices.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ClassicMobileServices.json new file mode 100644 index 000000000000..dcd85493870f --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ClassicMobileServices.json @@ -0,0 +1,264 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-02-01", + "title": "ClassicMobileServices API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/classicMobileServices": { + "get": { + "tags": [ + "ClassicMobileServices" + ], + "summary": "Get all mobile services for a subscription.", + "description": "Get all mobile services for a subscription.", + "operationId": "ClassicMobileServices_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClassicMobileServiceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices": { + "get": { + "tags": [ + "ClassicMobileServices" + ], + "summary": "Get all mobile services in a resource group.", + "description": "Get all mobile services in a resource group.", + "operationId": "ClassicMobileServices_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClassicMobileServiceCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}": { + "get": { + "tags": [ + "ClassicMobileServices" + ], + "summary": "Get a mobile service.", + "description": "Get a mobile service.", + "operationId": "ClassicMobileServices_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of mobile service", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClassicMobileService" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ClassicMobileServices" + ], + "summary": "Delete a mobile service.", + "description": "Delete a mobile service.", + "operationId": "ClassicMobileServices_Delete", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of mobile service", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ClassicMobileService": { + "description": "A mobile service.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "ClassicMobileService resource specific properties", + "properties": { + "name": { + "description": "Name of the mobile service.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "ClassicMobileServiceCollection": { + "description": "Collection of classic Mobile Services.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassicMobileService" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json index da30e23dc16e..2ad5370c9fd0 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json @@ -26,6 +26,16 @@ } } }, + "ApiManagementConfig": { + "description": "Azure API management (APIM) configuration linked to the app.", + "type": "object", + "properties": { + "id": { + "description": "APIM-Api Identifier.", + "type": "string" + } + } + }, "AppServiceEnvironment": { "description": "Description of an App Service Environment.", "required": [ @@ -517,54 +527,6 @@ } } }, - "AzureStorageInfoValue": { - "description": "Azure Files or Blob Storage access information value for dictionary storage.", - "type": "object", - "properties": { - "type": { - "description": "Type of storage.", - "enum": [ - "AzureFiles", - "AzureBlob" - ], - "type": "string", - "x-ms-enum": { - "name": "AzureStorageType", - "modelAsString": false - } - }, - "accountName": { - "description": "Name of the storage account.", - "type": "string" - }, - "shareName": { - "description": "Name of the file share (container name, for Blob storage).", - "type": "string" - }, - "accessKey": { - "description": "Access key for the storage account.", - "type": "string" - }, - "mountPath": { - "description": "Path to mount the storage within the site's runtime environment.", - "type": "string" - }, - "state": { - "description": "State of the storage account.", - "enum": [ - "Ok", - "InvalidCredentials", - "InvalidShare" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AzureStorageState", - "modelAsString": false - } - } - } - }, "Capability": { "description": "Describes the capabilities/features allowed for a specific SKU.", "type": "object", @@ -987,21 +949,6 @@ } } }, - "GeoDistribution": { - "description": "A global distribution definition.", - "type": "object", - "properties": { - "location": { - "description": "Location.", - "type": "string" - }, - "numberOfWorkers": { - "format": "int32", - "description": "NumberOfWorkers.", - "type": "integer" - } - } - }, "HandlerMapping": { "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.", "type": "object", @@ -1326,23 +1273,12 @@ "type": "string", "readOnly": true }, - "userAssignedIdentities": { - "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", - "additionalProperties": { - "type": "object", - "properties": { - "principalId": { - "description": "Principal Id of user assigned identity", - "type": "string", - "readOnly": true - }, - "clientId": { - "description": "Client Id of user assigned identity", - "type": "string", - "readOnly": true - } - } + "identityIds": { + "description": "Array of UserAssigned managed service identities.", + "type": "array", + "items": { + "description": "Resource Id for UserAssigned managed service identity", + "type": "string" } } } @@ -1604,7 +1540,7 @@ }, "changeStep": { "format": "double", - "description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.", + "description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.", "type": "number" }, "changeIntervalInMinutes": { @@ -2191,13 +2127,6 @@ "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" - }, - "geoDistributions": { - "description": "GeoDistributions for this site", - "type": "array", - "items": { - "$ref": "#/definitions/GeoDistribution" - } } }, "x-ms-client-flatten": true @@ -2289,13 +2218,6 @@ "$ref": "#/definitions/NameValuePair" } }, - "azureStorageAccounts": { - "description": "User-provided Azure storage accounts.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AzureStorageInfoValue" - } - }, "connectionStrings": { "description": "Connection strings.", "type": "array", @@ -2444,6 +2366,10 @@ "$ref": "#/definitions/ApiDefinitionInfo", "description": "Information about the formal API definition for the app." }, + "apiManagementConfig": { + "$ref": "#/definitions/ApiManagementConfig", + "description": "Azure API management settings linked to the app." + }, "autoSwapSlotName": { "description": "Auto-swap slot name.", "type": "string" @@ -2512,12 +2438,16 @@ "modelAsString": true } }, - "reservedInstanceCount": { + "preWarmedInstanceCount": { "format": "int32", - "description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan", + "description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans", "maximum": 10, "minimum": 0, "type": "integer" + }, + "healthCheckPath": { + "description": "Health check path", + "type": "string" } } }, @@ -3139,4 +3069,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json index d0543f2bd1e8..4be504604c9b 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json @@ -181,11 +181,11 @@ } }, "x-ms-examples": { - "Get App Slot Detector Responses": { - "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json" - }, "Get App Detector Responses": { "$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json" + }, + "Get App Slot Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json" } }, "x-ms-pageable": { @@ -262,11 +262,11 @@ } }, "x-ms-examples": { - "Get App Slot Detector Response": { - "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json" - }, "Get App Detector Response": { "$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json" + }, + "Get App Slot Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json" } } } @@ -786,11 +786,11 @@ } }, "x-ms-examples": { - "Get App Slot Detector Responses": { - "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json" - }, "Get App Detector Responses": { "$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json" + }, + "Get App Slot Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json" } }, "x-ms-pageable": { @@ -874,11 +874,11 @@ } }, "x-ms-examples": { - "Get App Slot Detector Response": { - "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json" - }, "Get App Detector Response": { "$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json" + }, + "Get App Slot Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json" } } } diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Recommendations.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Recommendations.json index 647d8f6fb92e..bac5c7031916 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Recommendations.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Recommendations.json @@ -1021,4 +1021,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json index b4fb9ae9d472..d03a3751c0d9 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json @@ -1346,4 +1346,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json index 46d6fe94216d..899fe56656cc 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json @@ -2999,7 +2999,7 @@ } }, "404": { - "description": "Function with an name of {functionName} is not running." + "description": "Function with an name of {functionName} does not exist." } } }, @@ -3102,14 +3102,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName}": { + "put": { "tags": [ "WebApps" ], - "summary": "Get function secrets for a function in a web site, or a deployment slot.", - "description": "Get function secrets for a function in a web site, or a deployment slot.", - "operationId": "WebApps_ListFunctionSecrets", + "summary": "Add or update a function secret.", + "description": "Add or update a function secret.", + "operationId": "WebApps_CreateOrUpdateFunctionSecret", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3124,10 +3124,26 @@ { "name": "functionName", "in": "path", - "description": "Function name.", + "description": "The name of the function.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", "required": true, "type": "string" }, + { + "name": "key", + "in": "body", + "description": "The key to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3136,10 +3152,16 @@ } ], "responses": { + "202": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, "200": { - "description": "Function secrets returned.", + "description": "Key was updated.", "schema": { - "$ref": "#/definitions/FunctionSecrets" + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -3149,16 +3171,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Get hostname bindings for an app or a deployment slot.", - "description": "Get hostname bindings for an app or a deployment slot.", - "operationId": "WebApps_ListHostNameBindings", + "summary": "Delete a function secret.", + "description": "Delete a function secret.", + "operationId": "WebApps_DeleteFunctionSecret", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3166,7 +3186,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "The name of the function.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", "required": true, "type": "string" }, @@ -3178,32 +3212,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostNameBindingCollection" - } + "404": { + "description": "Key was not found." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Key was deleted." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Get the named hostname binding for an app (or deployment slot, if specified).", - "description": "Get the named hostname binding for an app (or deployment slot, if specified).", - "operationId": "WebApps_GetHostNameBinding", + "summary": "Get function keys for a function in a web site, or a deployment slot.", + "description": "Get function keys for a function in a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctionKeys", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3211,14 +3236,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "hostName", + "name": "functionName", "in": "path", - "description": "Hostname in the hostname binding.", + "description": "Function name.", "required": true, "type": "string" }, @@ -3231,9 +3256,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function keys returned.", "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -3243,14 +3268,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets": { + "post": { "tags": [ "WebApps" ], - "summary": "Creates a hostname binding for an app.", - "description": "Creates a hostname binding for an app.", - "operationId": "WebApps_CreateOrUpdateHostNameBinding", + "summary": "Get function secrets for a function in a web site, or a deployment slot.", + "description": "Get function secrets for a function in a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctionSecrets", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3258,26 +3285,17 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "hostName", + "name": "functionName", "in": "path", - "description": "Hostname in the hostname binding.", + "description": "Function name.", "required": true, "type": "string" }, - { - "name": "hostNameBinding", - "in": "body", - "description": "Binding details. This is the JSON representation of a HostNameBinding object.", - "required": true, - "schema": { - "$ref": "#/definitions/HostNameBinding" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3287,9 +3305,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function secrets returned.", "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/FunctionKeys" } }, "default": { @@ -3299,14 +3317,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/status": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes a hostname binding for an app.", - "description": "Deletes a hostname binding for an app.", - "operationId": "WebApps_DeleteHostNameBinding", + "summary": "Get the status of a function (e.g. errors, etc.)", + "description": "Get the status of a function (e.g. errors, etc.)", + "operationId": "WebApps_GetFunctionStatus", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3314,14 +3334,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "hostName", + "name": "functionName", "in": "path", - "description": "Hostname in the hostname binding.", + "description": "Function name.", "required": true, "type": "string" }, @@ -3334,22 +3354,25 @@ ], "responses": { "200": { - "description": "Successfully deleted hostname binding." + "description": "Function status returned.", + "schema": { + "$ref": "#/definitions/FunctionStatus" + } }, - "204": { - "description": "Hostname binding does not exist." + "404": { + "description": "Function with an name of {functionName} does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.", - "description": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.", - "operationId": "WebApps_GetHybridConnection", + "summary": "Get host secrets for a function app.", + "description": "Get host secrets for a function app.", + "operationId": "WebApps_ListHostKeys", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3357,21 +3380,7 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", - "required": true, - "type": "string" - }, - { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection.", - "required": true, - "type": "string" - }, - { - "name": "relayName", - "in": "path", - "description": "The relay name for this hybrid connection.", + "description": "Site name.", "required": true, "type": "string" }, @@ -3384,9 +3393,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Host secrets returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/HostKeys" } }, "default": { @@ -3396,14 +3405,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus": { + "post": { "tags": [ "WebApps" ], - "summary": "Creates a new Hybrid Connection using a Service Bus relay.", - "description": "Creates a new Hybrid Connection using a Service Bus relay.", - "operationId": "WebApps_CreateOrUpdateHybridConnection", + "summary": "This is to allow calling via powershell and ARM template.", + "description": "This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncStatus", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3411,32 +3422,42 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection.", - "required": true, - "type": "string" + "$ref": "#/parameters/subscriptionIdParameter" }, { - "name": "relayName", - "in": "path", - "description": "The relay name for this hybrid connection.", - "required": true, - "type": "string" + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/status": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the current Function host status.", + "description": "Gets the current Function host status.", + "operationId": "WebApps_GetHostStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "The details of the hybrid connection.", + "name": "name", + "in": "path", + "description": "Site name.", "required": true, - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -3449,7 +3470,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/HostStatus" } }, "default": { @@ -3459,14 +3480,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync": { + "post": { "tags": [ "WebApps" ], - "summary": "Removes a Hybrid Connection from this site.", - "description": "Removes a Hybrid Connection from this site.", - "operationId": "WebApps_DeleteHybridConnection", + "summary": "Syncs function trigger metadata to the management database", + "description": "Syncs function trigger metadata to the management database", + "operationId": "WebApps_SyncFunctions", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3474,21 +3497,7 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", - "required": true, - "type": "string" - }, - { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection.", - "required": true, - "type": "string" - }, - { - "name": "relayName", - "in": "path", - "description": "The relay name for this hybrid connection.", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -3500,21 +3509,20 @@ } ], "responses": { - "200": { - "description": "Successfully deleted hybrid connection." - }, - "404": { - "description": "Hybrid connection does not exist." + "204": { + "description": "No Content" } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}": { + "put": { "tags": [ "WebApps" ], - "summary": "Creates a new Hybrid Connection using a Service Bus relay.", - "description": "Creates a new Hybrid Connection using a Service Bus relay.", - "operationId": "WebApps_UpdateHybridConnection", + "summary": "Add or update a host level secret.", + "description": "Add or update a host level secret.", + "operationId": "WebApps_CreateOrUpdateHostSecret", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3522,31 +3530,31 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "namespaceName", + "name": "keyType", "in": "path", - "description": "The namespace for this hybrid connection.", + "description": "The type of host key.", "required": true, "type": "string" }, { - "name": "relayName", + "name": "keyName", "in": "path", - "description": "The relay name for this hybrid connection.", + "description": "The name of the key.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", + "name": "key", "in": "body", - "description": "The details of the hybrid connection.", + "description": "The key to create or update", "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/KeyInfo" } }, { @@ -3557,10 +3565,16 @@ } ], "responses": { + "202": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, "200": { - "description": "OK", + "description": "Key was updated.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -3570,16 +3584,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { - "post": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets the send key name and value for a Hybrid Connection.", - "description": "Gets the send key name and value for a Hybrid Connection.", - "operationId": "WebApps_ListHybridConnectionKeys", + "summary": "Delete a host level secret.", + "description": "Delete a host level secret.", + "operationId": "WebApps_DeleteHostSecret", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3587,63 +3599,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", - "required": true, - "type": "string" - }, - { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "relayName", + "name": "keyType", "in": "path", - "description": "The relay name for this hybrid connection.", + "description": "The type of host key.", "required": true, "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnectionKey" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.", - "description": "Retrieves all Service Bus Hybrid Connections used by this Web App.", - "operationId": "WebApps_ListHybridConnections", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", + "name": "keyName", "in": "path", - "description": "The name of the web app.", + "description": "The name of the key.", "required": true, "type": "string" }, @@ -3655,29 +3625,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" - } + "404": { + "description": "Key was not found." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Key was deleted." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { "get": { "tags": [ "WebApps" ], - "summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).", - "description": "Gets hybrid connections configured for an app (or deployment slot, if specified).", - "operationId": "WebApps_ListRelayServiceConnections", + "summary": "Get hostname bindings for an app or a deployment slot.", + "description": "Get hostname bindings for an app or a deployment slot.", + "operationId": "WebApps_ListHostNameBindings", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3700,7 +3664,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/HostNameBindingCollection" } }, "default": { @@ -3709,17 +3673,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a hybrid connection configuration by its name.", - "description": "Gets a hybrid connection configuration by its name.", - "operationId": "WebApps_GetRelayServiceConnection", + "summary": "Get the named hostname binding for an app (or deployment slot, if specified).", + "description": "Get the named hostname binding for an app (or deployment slot, if specified).", + "operationId": "WebApps_GetHostNameBinding", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3732,9 +3699,9 @@ "type": "string" }, { - "name": "entityName", + "name": "hostName", "in": "path", - "description": "Name of the hybrid connection.", + "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, @@ -3749,7 +3716,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/HostNameBinding" } }, "default": { @@ -3764,9 +3731,9 @@ "tags": [ "WebApps" ], - "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", - "description": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", - "operationId": "WebApps_CreateOrUpdateRelayServiceConnection", + "summary": "Creates a hostname binding for an app.", + "description": "Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdateHostNameBinding", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3779,19 +3746,19 @@ "type": "string" }, { - "name": "entityName", + "name": "hostName", "in": "path", - "description": "Name of the hybrid connection configuration.", + "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", + "name": "hostNameBinding", "in": "body", - "description": "Details of the hybrid connection configuration.", + "description": "Binding details. This is the JSON representation of a HostNameBinding object.", "required": true, "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/HostNameBinding" } }, { @@ -3805,7 +3772,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/HostNameBinding" } }, "default": { @@ -3820,9 +3787,9 @@ "tags": [ "WebApps" ], - "summary": "Deletes a relay service connection by its name.", - "description": "Deletes a relay service connection by its name.", - "operationId": "WebApps_DeleteRelayServiceConnection", + "summary": "Deletes a hostname binding for an app.", + "description": "Deletes a hostname binding for an app.", + "operationId": "WebApps_DeleteHostNameBinding", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3835,9 +3802,9 @@ "type": "string" }, { - "name": "entityName", + "name": "hostName", "in": "path", - "description": "Name of the hybrid connection configuration.", + "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, @@ -3850,20 +3817,22 @@ ], "responses": { "200": { - "description": "Successfully deleted relay service connection." + "description": "Successfully deleted hostname binding." }, - "404": { - "description": "Relay service connection does not exist." + "204": { + "description": "Hostname binding does not exist." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", - "description": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", - "operationId": "WebApps_UpdateRelayServiceConnection", + "summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.", + "description": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.", + "operationId": "WebApps_GetHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3871,25 +3840,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "name": "entityName", + "name": "namespaceName", "in": "path", - "description": "Name of the hybrid connection configuration.", + "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "Details of the hybrid connection configuration.", + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -3902,7 +3869,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { @@ -3912,16 +3879,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets all scale-out instances of an app.", - "description": "Gets all scale-out instances of an app.", - "operationId": "WebApps_ListInstanceIdentifiers", + "summary": "Creates a new Hybrid Connection using a Service Bus relay.", + "description": "Creates a new Hybrid Connection using a Service Bus relay.", + "operationId": "WebApps_CreateOrUpdateHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3929,10 +3894,33 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the hybrid connection.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3944,7 +3932,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WebAppInstanceCollection" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { @@ -3953,20 +3941,15 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Get the status of the last MSDeploy operation.", - "description": "Get the status of the last MSDeploy operation.", - "operationId": "WebApps_GetInstanceMsDeployStatus", + "summary": "Removes a Hybrid Connection from this site.", + "description": "Removes a Hybrid Connection from this site.", + "operationId": "WebApps_DeleteHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3974,14 +3957,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "namespaceName", "in": "path", - "description": "ID of web app instance.", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, @@ -3994,26 +3984,20 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MSDeployStatus" - } + "description": "Successfully deleted hybrid connection." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Hybrid connection does not exist." } } }, - "put": { + "patch": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension.", - "description": "Invoke the MSDeploy web app extension.", - "operationId": "WebApps_CreateInstanceMSDeployOperation", + "summary": "Creates a new Hybrid Connection using a Service Bus relay.", + "description": "Creates a new Hybrid Connection using a Service Bus relay.", + "operationId": "WebApps_UpdateHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4021,24 +4005,31 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "namespaceName", "in": "path", - "description": "ID of web app instance.", + "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { - "name": "MSDeploy", - "in": "body", - "description": "Details of MSDeploy operation", - "required": true, - "schema": { - "$ref": "#/definitions/MSDeploy" + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the hybrid connection.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, { @@ -4049,27 +4040,29 @@ } ], "responses": { - "201": { - "description": "Deployment is scheduled.", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, - "409": { - "description": "Another deployment is in progress." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Get the MSDeploy Log for the last MSDeploy operation.", - "description": "Get the MSDeploy Log for the last MSDeploy operation.", - "operationId": "WebApps_GetInstanceMSDeployLog", + "summary": "Gets the send key name and value for a Hybrid Connection.", + "description": "Gets the send key name and value for a Hybrid Connection.", + "operationId": "WebApps_ListHybridConnectionKeys", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4077,14 +4070,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "namespaceName", "in": "path", - "description": "ID of web app instance.", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, @@ -4097,25 +4097,28 @@ ], "responses": { "200": { - "description": "MSDeploy log returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployLog" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnectionKey" } }, - "404": { - "description": "MSDeploy log not found." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": { "get": { "tags": [ "WebApps" ], - "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", - "description": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListInstanceProcesses", + "summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.", + "description": "Retrieves all Service Bus Hybrid Connections used by this Web App.", + "operationId": "WebApps_ListHybridConnections", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4123,14 +4126,7 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "description": "The name of the web app.", "required": true, "type": "string" }, @@ -4143,28 +4139,28 @@ ], "responses": { "200": { - "description": "Process terminated.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessInfoCollection" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, - "404": { - "description": "Process with the specified ID is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { "get": { "tags": [ "WebApps" ], - "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", - "description": "Get process information by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetInstanceProcess", + "summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).", + "description": "Gets hybrid connections configured for an app (or deployment slot, if specified).", + "operationId": "WebApps_ListRelayServiceConnections", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4172,21 +4168,7 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -4199,23 +4181,28 @@ ], "responses": { "200": { - "description": "Process information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } }, - "404": { - "description": "Process with the specified ID is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", - "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", - "operationId": "WebApps_DeleteInstanceProcess", + "summary": "Gets a hybrid connection configuration by its name.", + "description": "Gets a hybrid connection configuration by its name.", + "operationId": "WebApps_GetRelayServiceConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4223,21 +4210,14 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "processId", - "in": "path", - "description": "PID.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "entityName", "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "description": "Name of the hybrid connection.", "required": true, "type": "string" }, @@ -4249,23 +4229,27 @@ } ], "responses": { - "204": { - "description": "Process terminated." + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } }, - "404": { - "description": "Process with the specified ID is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", - "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetInstanceProcessDump", + "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "description": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "operationId": "WebApps_CreateOrUpdateRelayServiceConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4273,23 +4257,25 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", + "name": "entityName", "in": "path", - "description": "PID.", + "description": "Name of the hybrid connection configuration.", "required": true, "type": "string" }, { - "name": "instanceId", - "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4302,23 +4288,24 @@ "200": { "description": "OK", "schema": { - "type": "file" + "$ref": "#/definitions/RelayServiceConnectionEntity" } }, - "404": { - "description": "Process with the specified ID is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", - "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListInstanceProcessModules", + "summary": "Deletes a relay service connection by its name.", + "description": "Deletes a relay service connection by its name.", + "operationId": "WebApps_DeleteRelayServiceConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4326,21 +4313,14 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "processId", - "in": "path", - "description": "PID.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "entityName", "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "description": "Name of the hybrid connection configuration.", "required": true, "type": "string" }, @@ -4353,28 +4333,20 @@ ], "responses": { "200": { - "description": "Module information returned.", - "schema": { - "$ref": "#/definitions/ProcessModuleInfoCollection" - } + "description": "Successfully deleted relay service connection." }, "404": { - "description": "Process with the specified ID is not running." + "description": "Relay service connection does not exist." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": { - "get": { + }, + "patch": { "tags": [ "WebApps" ], - "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", - "description": "Get process information by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetInstanceProcessModule", + "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "description": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", + "operationId": "WebApps_UpdateRelayServiceConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4382,30 +4354,25 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, - { - "name": "baseAddress", + "name": "entityName", "in": "path", - "description": "Module base address.", + "description": "Name of the hybrid connection configuration.", "required": true, "type": "string" }, { - "name": "instanceId", - "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4416,25 +4383,28 @@ ], "responses": { "200": { - "description": "Module information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessModuleInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } }, - "404": { - "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { "get": { "tags": [ "WebApps" ], - "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", - "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListInstanceProcessThreads", + "summary": "Gets all scale-out instances of an app.", + "description": "Gets all scale-out instances of an app.", + "operationId": "WebApps_ListInstanceIdentifiers", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4442,21 +4412,7 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -4469,13 +4425,16 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessThreadInfoCollection" + "$ref": "#/definitions/WebAppInstanceCollection" } }, - "404": { - "description": "Process with the specified ID is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } }, "x-ms-pageable": { @@ -4483,14 +4442,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads/{threadId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], - "summary": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", - "description": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetInstanceProcessThread", + "summary": "Get the status of the last MSDeploy operation.", + "description": "Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMsDeployStatus", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4498,28 +4457,14 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, - { - "name": "threadId", - "in": "path", - "description": "TID.", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "description": "ID of web app instance.", "required": true, "type": "string" }, @@ -4532,25 +4477,26 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessThreadInfo" + "$ref": "#/definitions/MSDeployStatus" } }, - "404": { - "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Shows whether an app can be cloned to another resource group or subscription.", - "description": "Shows whether an app can be cloned to another resource group or subscription.", - "operationId": "WebApps_IsCloneable", + "summary": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateInstanceMSDeployOperation", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4558,10 +4504,26 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", "required": true, "type": "string" }, + { + "name": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", + "required": true, + "schema": { + "$ref": "#/definitions/MSDeploy" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -4570,29 +4532,27 @@ } ], "responses": { - "200": { - "description": "OK.", + "201": { + "description": "Deployment is scheduled.", "schema": { - "$ref": "#/definitions/SiteCloneability" + "$ref": "#/definitions/MSDeployStatus" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "409": { + "description": "Another deployment is in progress." } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": { + "get": { "tags": [ "WebApps" ], - "summary": "This is to allow calling via powershell and ARM template.", - "description": "This is to allow calling via powershell and ARM template.", - "operationId": "WebApps_ListSyncFunctionTriggers", + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMSDeployLog", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4600,7 +4560,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", "required": true, "type": "string" }, @@ -4613,28 +4580,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "MSDeploy log returned.", "schema": { - "$ref": "#/definitions/FunctionSecrets" + "$ref": "#/definitions/MSDeployLog" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "MSDeploy log not found." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": { "get": { "tags": [ "WebApps" ], - "summary": "Gets all metric definitions of an app (or deployment slot, if specified).", - "description": "Gets all metric definitions of an app (or deployment slot, if specified).", - "operationId": "WebApps_ListMetricDefinitions", + "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "description": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcesses", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4642,7 +4606,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, @@ -4655,16 +4626,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process terminated.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection" + "$ref": "#/definitions/ProcessInfoCollection" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { @@ -4672,14 +4640,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets performance metrics of an app (or deployment slot, if specified).", - "description": "Gets performance metrics of an app (or deployment slot, if specified).", - "operationId": "WebApps_ListMetrics", + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4687,22 +4655,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "details", - "in": "query", - "description": "Specify \"true\" to include metric details in the response. It is \"false\" by default.", - "type": "boolean" + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" }, { - "name": "$filter", - "in": "query", - "description": "Return only metrics specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string", - "x-ms-skip-url-encoding": true + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4713,57 +4682,1277 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process information returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricCollection" + "$ref": "#/definitions/ProcessInfo" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": { - "put": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Restores a web app.", - "description": "Restores a web app.", + "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "operationId": "WebApps_DeleteInstanceProcess", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcessDump", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "404": { + "description": "Process with the specified ID is not running." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", + "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcessModules", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcessModule", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "baseAddress", + "in": "path", + "description": "Module base address.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListInstanceProcessThreads", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads/{threadId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", + "description": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetInstanceProcessThread", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "threadId", + "in": "path", + "description": "TID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfo" + } + }, + "404": { + "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Shows whether an app can be cloned to another resource group or subscription.", + "description": "Shows whether an app can be cloned to another resource group or subscription.", + "operationId": "WebApps_IsCloneable", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SiteCloneability" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listbackups": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets existing backups of an app.", + "description": "Gets existing backups of an app.", + "operationId": "WebApps_ListSiteBackups", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItemCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "This is to allow calling via powershell and ARM template.", + "description": "This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncFunctionTriggersStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all metric definitions of an app (or deployment slot, if specified).", + "description": "Gets all metric definitions of an app (or deployment slot, if specified).", + "operationId": "WebApps_ListMetricDefinitions", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets performance metrics of an app (or deployment slot, if specified).", + "description": "Gets performance metrics of an app (or deployment slot, if specified).", + "operationId": "WebApps_ListMetrics", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "Specify \"true\" to include metric details in the response. It is \"false\" by default.", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only metrics specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Restores a web app.", + "description": "Restores a web app.", "operationId": "WebApps_MigrateStorage", "parameters": [ { - "name": "subscriptionName", - "in": "query", - "description": "Azure subscription.", + "name": "subscriptionName", + "in": "query", + "description": "Azure subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "migrationOptions", + "in": "body", + "description": "Migration migrationOptions.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageMigrationOptions" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageMigrationResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Migrates a local (in-app) MySql database to a remote MySql database.", + "description": "Migrates a local (in-app) MySql database to a remote MySql database.", + "operationId": "WebApps_MigrateMySql", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "migrationRequestEnvelope", + "in": "body", + "description": "MySql migration options.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrateMySqlRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Operation" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", + "description": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", + "operationId": "WebApps_GetMigrateMySqlStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrateMySqlStatus" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a Swift Virtual Network connection.", + "description": "Gets a Swift Virtual Network connection.", + "operationId": "WebApps_GetSwiftVirtualNetworkConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "description": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "operationId": "WebApps_DeleteSwiftVirtualNetwork", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist." + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_UpdateSwiftVirtualNetworkConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all network features used by the app (or deployment slot, if specified).", + "description": "Gets all network features used by the app (or deployment slot, if specified).", + "operationId": "WebApps_ListNetworkFeatures", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "view", + "in": "path", + "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NetworkFeatures" + } + }, + "404": { + "description": "The requested view does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraceOperation", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site (To be deprecated).", + "description": "Start capturing network packets for the site (To be deprecated).", + "operationId": "WebApps_StartWebSiteNetworkTrace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site.", + "description": "Start capturing network packets for the site.", + "operationId": "WebApps_StartWebSiteNetworkTraceOperation", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a new network trace operation for a site": { + "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop ongoing capturing network packets for the site.", + "description": "Stop ongoing capturing network packets for the site.", + "operationId": "WebApps_StopWebSiteNetworkTrace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", "required": true, "type": "string" }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Stopped." + }, + "204": { + "description": "Stopped." + } + }, + "x-ms-examples": { + "Stop a currently running network trace operation for a site": { + "$ref": "./examples/StopWebSiteNetworkTrace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraces", + "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "migrationOptions", - "in": "body", - "description": "Migration migrationOptions.", + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/StorageMigrationOptions" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } + } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraceOperationV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4776,7 +5965,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StorageMigrationResponse" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -4786,17 +5987,21 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + } + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Migrates a local (in-app) MySql database to a remote MySql database.", - "description": "Migrates a local (in-app) MySql database to a remote MySql database.", - "operationId": "WebApps_MigrateMySql", + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTracesV2", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4804,18 +6009,109 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "migrationRequestEnvelope", - "in": "body", - "description": "MySql migration options.", + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/MigrateMySqlRequest" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } + } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Generates a new publishing password for an app (or deployment slot, if specified).", + "description": "Generates a new publishing password for an app (or deployment slot, if specified).", + "operationId": "WebApps_GenerateNewSitePublishingPassword", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generate new password." + }, + "204": { + "description": "Successfully generate new password." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets perfmon counters for web app.", + "description": "Gets perfmon counters for web app.", + "operationId": "WebApps_ListPerfMonCounters", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string", + "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4828,7 +6124,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "$ref": "#/definitions/PerfMonCounterCollection" } }, "default": { @@ -4838,17 +6134,19 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": { "get": { "tags": [ "WebApps" ], - "summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", - "description": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", - "operationId": "WebApps_GetMigrateMySqlStatus", + "summary": "Gets web app's event logs.", + "description": "Gets web app's event logs.", + "operationId": "WebApps_GetSitePhpErrorLogFlag", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4871,7 +6169,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MigrateMySqlStatus" + "$ref": "#/definitions/SitePhpErrorLogFlag" } }, "default": { @@ -4883,14 +6181,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a Swift Virtual Network connection.", - "description": "Gets a Swift Virtual Network connection.", - "operationId": "WebApps_GetSwiftVirtualNetworkConnection", + "summary": "Gets the premier add-ons of an app.", + "description": "Gets the premier add-ons of an app.", + "operationId": "WebApps_ListPremierAddOns", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4911,9 +6209,9 @@ ], "responses": { "200": { - "description": "OK.", + "description": "OK", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "#/definitions/PremierAddOn" } }, "default": { @@ -4923,14 +6221,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", - "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", - "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnection", + "summary": "Gets a named add-on of an app.", + "description": "Gets a named add-on of an app.", + "operationId": "WebApps_GetPremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4943,13 +6243,11 @@ "type": "string" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "Properties of the Virtual Network connection. See example.", + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", "required": true, - "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4962,7 +6260,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "#/definitions/PremierAddOn" } }, "default": { @@ -4973,13 +6271,13 @@ } } }, - "delete": { + "put": { "tags": [ "WebApps" ], - "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", - "description": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", - "operationId": "WebApps_DeleteSwiftVirtualNetwork", + "summary": "Updates a named add-on of an app.", + "description": "Updates a named add-on of an app.", + "operationId": "WebApps_AddPremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4992,46 +6290,19 @@ "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted virtual network." - }, - "404": { - "description": "Virtual network does not exist." - } - } - }, - "patch": { - "tags": [ - "WebApps" - ], - "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", - "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", - "operationId": "WebApps_UpdateSwiftVirtualNetworkConnection", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", + "name": "premierAddOnName", "in": "path", - "description": "Name of the app.", + "description": "Add-on name.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", + "name": "premierAddOn", "in": "body", - "description": "Properties of the Virtual Network connection. See example.", + "description": "A JSON representation of the edited premier add-on.", "required": true, "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "#/definitions/PremierAddOn" } }, { @@ -5045,7 +6316,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "#/definitions/PremierAddOn" } }, "default": { @@ -5055,16 +6326,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets all network features used by the app (or deployment slot, if specified).", - "description": "Gets all network features used by the app (or deployment slot, if specified).", - "operationId": "WebApps_ListNetworkFeatures", + "summary": "Delete a premier add-on from an app.", + "description": "Delete a premier add-on from an app.", + "operationId": "WebApps_DeletePremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5077,9 +6346,9 @@ "type": "string" }, { - "name": "view", + "name": "premierAddOnName", "in": "path", - "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "description": "Add-on name.", "required": true, "type": "string" }, @@ -5092,25 +6361,17 @@ ], "responses": { "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/NetworkFeatures" - } - }, - "404": { - "description": "The requested view does not exist." + "description": "Successfully deleted premier add-on." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}": { - "get": { + }, + "patch": { "tags": [ "WebApps" ], - "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "operationId": "WebApps_GetNetworkTraceOperation", + "summary": "Updates a named add-on of an app.", + "description": "Updates a named add-on of an app.", + "operationId": "WebApps_UpdatePremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5123,90 +6384,20 @@ "type": "string" }, { - "name": "operationId", + "name": "premierAddOnName", "in": "path", - "description": "GUID of the operation.", + "description": "Add-on name.", "required": true, "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } - }, - "202": { - "description": "Operation is in progress.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } - }, - "default": { - "description": "App Service error response.", + "name": "premierAddOn", + "in": "body", + "description": "A JSON representation of the edited premier add-on.", + "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "#/definitions/PremierAddOnPatchResource" } - } - }, - "x-ms-examples": { - "Get the current status of a network trace operation for a site": { - "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": { - "post": { - "tags": [ - "WebApps" - ], - "summary": "Start capturing network packets for the site (To be deprecated).", - "description": "Start capturing network packets for the site (To be deprecated).", - "operationId": "WebApps_StartWebSiteNetworkTrace", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app.", - "required": true, - "type": "string" - }, - { - "name": "durationInSeconds", - "in": "query", - "description": "The duration to keep capturing in seconds.", - "type": "integer", - "format": "int32" - }, - { - "name": "maxFrameLength", - "in": "query", - "description": "The maximum frame length in bytes (Optional).", - "type": "integer", - "format": "int32" - }, - { - "name": "sasUrl", - "in": "query", - "description": "The Blob URL to store capture file.", - "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -5219,7 +6410,7 @@ "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/PremierAddOn" } }, "default": { @@ -5231,43 +6422,23 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { + "get": { "tags": [ "WebApps" ], - "summary": "Start capturing network packets for the site.", - "description": "Start capturing network packets for the site.", - "operationId": "WebApps_StartWebSiteNetworkTraceOperation", + "summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", + "description": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", + "operationId": "WebApps_GetPrivateAccess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", - "in": "path", - "description": "The name of the web app.", - "required": true, - "type": "string" - }, - { - "name": "durationInSeconds", - "in": "query", - "description": "The duration to keep capturing in seconds.", - "type": "integer", - "format": "int32" - }, - { - "name": "maxFrameLength", - "in": "query", - "description": "The maximum frame length in bytes (Optional).", - "type": "integer", - "format": "int32" - }, - { - "name": "sasUrl", - "in": "query", - "description": "The Blob URL to store capture file.", + "in": "path", + "description": "The name of the web app.", + "required": true, "type": "string" }, { @@ -5281,19 +6452,7 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } - }, - "202": { - "description": "Operation is in progress.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$ref": "#/definitions/PrivateAccess" } }, "default": { @@ -5302,23 +6461,15 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-examples": { - "Start a new network trace operation for a site": { - "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": { - "post": { + } + }, + "put": { "tags": [ "WebApps" ], - "summary": "Stop ongoing capturing network packets for the site.", - "description": "Stop ongoing capturing network packets for the site.", - "operationId": "WebApps_StopWebSiteNetworkTrace", + "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", + "description": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", + "operationId": "WebApps_PutPrivateAccessVnet", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5330,6 +6481,15 @@ "required": true, "type": "string" }, + { + "name": "access", + "in": "body", + "description": "The information for the private access", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5339,27 +6499,28 @@ ], "responses": { "200": { - "description": "Stopped." + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateAccess" + } }, - "204": { - "description": "Stopped." - } - }, - "x-ms-examples": { - "Stop a currently running network trace operation for a site": { - "$ref": "./examples/StopWebSiteNetworkTrace.json" + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "operationId": "WebApps_GetNetworkTraces", + "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "description": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcesses", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5367,14 +6528,7 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "GUID of the operation.", + "description": "Site name.", "required": true, "type": "string" }, @@ -5387,36 +6541,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process terminated.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$ref": "#/definitions/ProcessInfoCollection" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } }, - "x-ms-examples": { - "Get NetworkTraces for a site": { - "$ref": "./examples/GetWebSiteNetworkTraces.json" - } + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "operationId": "WebApps_GetNetworkTraceOperationV2", + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5424,14 +6570,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "operationId", + "name": "processId", "in": "path", - "description": "GUID of the operation.", + "description": "PID.", "required": true, "type": "string" }, @@ -5444,45 +6590,23 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } - }, - "202": { - "description": "Operation is in progress.", + "description": "Process information returned.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$ref": "#/definitions/ProcessInfo" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Get the current status of a network trace operation for a site": { - "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + "404": { + "description": "Process with the specified ID is not running." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "operationId": "WebApps_GetNetworkTracesV2", + "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "operationId": "WebApps_DeleteProcess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5490,14 +6614,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "operationId", + "name": "processId", "in": "path", - "description": "GUID of the operation.", + "description": "PID.", "required": true, "type": "string" }, @@ -5509,37 +6633,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } + "204": { + "description": "Process terminated." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Get NetworkTraces for a site": { - "$ref": "./examples/GetWebSiteNetworkTraces.json" + "404": { + "description": "Process with the specified ID is not running." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": { + "get": { "tags": [ "WebApps" ], - "summary": "Generates a new publishing password for an app (or deployment slot, if specified).", - "description": "Generates a new publishing password for an app (or deployment slot, if specified).", - "operationId": "WebApps_GenerateNewSitePublishingPassword", + "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcessDump", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5547,7 +6657,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", "required": true, "type": "string" }, @@ -5560,22 +6677,25 @@ ], "responses": { "200": { - "description": "Successfully generate new password." + "description": "OK", + "schema": { + "type": "file" + } }, - "204": { - "description": "Successfully generate new password." + "404": { + "description": "Process with the specified ID is not running." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": { "get": { "tags": [ "WebApps" ], - "summary": "Gets perfmon counters for web app.", - "description": "Gets perfmon counters for web app.", - "operationId": "WebApps_ListPerfMonCounters", + "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", + "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcessModules", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5583,16 +6703,16 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string", - "x-ms-skip-url-encoding": true + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -5603,16 +6723,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "#/definitions/PerfMonCounterCollection" + "$ref": "#/definitions/ProcessModuleInfoCollection" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { @@ -5620,22 +6737,36 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets web app's event logs.", - "description": "Gets web app's event logs.", - "operationId": "WebApps_GetSitePhpErrorLogFlag", + "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", + "description": "Get process information by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcessModule", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" }, { - "name": "name", + "name": "baseAddress", "in": "path", - "description": "Name of web app.", + "description": "Module base address.", "required": true, "type": "string" }, @@ -5648,28 +6779,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "#/definitions/SitePhpErrorLogFlag" + "$ref": "#/definitions/ProcessModuleInfo" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the premier add-ons of an app.", - "description": "Gets the premier add-ons of an app.", - "operationId": "WebApps_ListPremierAddOns", + "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", + "operationId": "WebApps_ListProcessThreads", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5677,7 +6805,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", "required": true, "type": "string" }, @@ -5690,28 +6825,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/ProcessThreadInfoCollection" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a named add-on of an app.", - "description": "Gets a named add-on of an app.", - "operationId": "WebApps_GetPremierAddOn", + "summary": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", + "description": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", + "operationId": "WebApps_GetProcessThread", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5719,14 +6854,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "premierAddOnName", + "name": "processId", "in": "path", - "description": "Add-on name.", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "threadId", + "in": "path", + "description": "TID.", "required": true, "type": "string" }, @@ -5739,26 +6881,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/ProcessThreadInfo" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates a named add-on of an app.", - "description": "Updates a named add-on of an app.", - "operationId": "WebApps_AddPremierAddOn", + "summary": "Get public certificates for an app or a deployment slot.", + "description": "Get public certificates for an app or a deployment slot.", + "operationId": "WebApps_ListPublicCertificates", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5770,22 +6911,6 @@ "required": true, "type": "string" }, - { - "name": "premierAddOnName", - "in": "path", - "description": "Add-on name.", - "required": true, - "type": "string" - }, - { - "name": "premierAddOn", - "in": "body", - "description": "A JSON representation of the edited premier add-on.", - "required": true, - "schema": { - "$ref": "#/definitions/PremierAddOn" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5797,7 +6922,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/PublicCertificateCollection" } }, "default": { @@ -5806,15 +6931,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Delete a premier add-on from an app.", - "description": "Delete a premier add-on from an app.", - "operationId": "WebApps_DeletePremierAddOn", + "summary": "Get the named public certificate for an app (or deployment slot, if specified).", + "description": "Get the named public certificate for an app (or deployment slot, if specified).", + "operationId": "WebApps_GetPublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5827,9 +6957,9 @@ "type": "string" }, { - "name": "premierAddOnName", + "name": "publicCertificateName", "in": "path", - "description": "Add-on name.", + "description": "Public certificate name.", "required": true, "type": "string" }, @@ -5842,17 +6972,26 @@ ], "responses": { "200": { - "description": "Successfully deleted premier add-on." + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } }, - "patch": { + "put": { "tags": [ "WebApps" ], - "summary": "Updates a named add-on of an app.", - "description": "Updates a named add-on of an app.", - "operationId": "WebApps_UpdatePremierAddOn", + "summary": "Creates a hostname binding for an app.", + "description": "Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdatePublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5865,19 +7004,19 @@ "type": "string" }, { - "name": "premierAddOnName", + "name": "publicCertificateName", "in": "path", - "description": "Add-on name.", + "description": "Public certificate name.", "required": true, "type": "string" }, { - "name": "premierAddOn", + "name": "publicCertificate", "in": "body", - "description": "A JSON representation of the edited premier add-on.", + "description": "Public certificate details. This is the JSON representation of a PublicCertificate object.", "required": true, "schema": { - "$ref": "#/definitions/PremierAddOnPatchResource" + "$ref": "#/definitions/PublicCertificate" } }, { @@ -5891,7 +7030,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/PublicCertificate" } }, "default": { @@ -5901,16 +7040,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", - "description": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", - "operationId": "WebApps_GetPrivateAccess", + "summary": "Deletes a hostname binding for an app.", + "description": "Deletes a hostname binding for an app.", + "operationId": "WebApps_DeletePublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5918,7 +7055,14 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", "required": true, "type": "string" }, @@ -5931,26 +7075,25 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PrivateAccess" - } + "description": "Successfully deleted hostname binding." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Hostname binding does not exist." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { + "post": { "tags": [ "WebApps" ], - "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", - "description": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", - "operationId": "WebApps_PutPrivateAccessVnet", + "summary": "Gets the publishing profile for an app (or deployment slot, if specified).", + "description": "Gets the publishing profile for an app (or deployment slot, if specified).", + "operationId": "WebApps_ListPublishingProfileXmlWithSecrets", + "produces": [ + "application/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5958,17 +7101,17 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "access", + "name": "publishingProfileOptions", "in": "body", - "description": "The information for the private access", + "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", "required": true, "schema": { - "$ref": "#/definitions/PrivateAccess" + "$ref": "#/definitions/CsmPublishingProfileOptions" } }, { @@ -5982,7 +7125,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PrivateAccess" + "type": "file" } }, "default": { @@ -5994,14 +7137,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { + "post": { "tags": [ "WebApps" ], - "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", - "description": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListProcesses", + "summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", + "description": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", + "operationId": "WebApps_ResetProductionSlotConfig", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6009,7 +7152,7 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -6022,28 +7165,19 @@ ], "responses": { "200": { - "description": "Process terminated.", - "schema": { - "$ref": "#/definitions/ProcessInfoCollection" - } - }, - "404": { - "description": "Process with the specified ID is not running." + "description": "OK." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { + "post": { "tags": [ "WebApps" - ], - "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", - "description": "Get process information by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetProcess", + ], + "summary": "Restarts an app (or deployment slot, if specified).", + "description": "Restarts an app (or deployment slot, if specified).", + "operationId": "WebApps_Restart", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6051,16 +7185,21 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" + "name": "softRestart", + "in": "query", + "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", + "type": "boolean" + }, + { + "name": "synchronous", + "in": "query", + "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", + "type": "boolean" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6071,23 +7210,19 @@ ], "responses": { "200": { - "description": "Process information returned.", - "schema": { - "$ref": "#/definitions/ProcessInfo" - } - }, - "404": { - "description": "Process with the specified ID is not running." + "description": "Successfully restarted app." } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": { + "post": { "tags": [ "WebApps" ], - "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", - "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", - "operationId": "WebApps_DeleteProcess", + "summary": "Restores an app from a backup blob in Azure Storage.", + "description": "Restores an app from a backup blob in Azure Storage.", + "operationId": "WebApps_RestoreFromBackupBlob", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6095,16 +7230,18 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", - "in": "path", - "description": "PID.", + "name": "request", + "in": "body", + "description": "Information on restore request .", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/RestoreRequest" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6114,23 +7251,24 @@ } ], "responses": { - "204": { - "description": "Process terminated." + "202": { + "description": "Restore operation started." }, - "404": { - "description": "Process with the specified ID is not running." + "200": { + "description": "Restore operation started." } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { + "post": { "tags": [ "WebApps" ], - "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", - "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetProcessDump", + "summary": "Restores a deleted web app to this web app.", + "description": "Restores a deleted web app to this web app.", + "operationId": "WebApps_RestoreFromDeletedApp", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6138,16 +7276,18 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "processId", - "in": "path", - "description": "PID.", + "name": "restoreRequest", + "in": "body", + "description": "Deleted web app restore information.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/DeletedAppRestoreRequest" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6157,26 +7297,24 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "file" - } + "202": { + "description": "Restore operation started." }, - "404": { - "description": "Process with the specified ID is not running." + "200": { + "description": "Restore operation started." } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": { + "post": { "tags": [ "WebApps" ], - "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", - "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListProcessModules", + "summary": "Restores a web app from a snapshot.", + "description": "Restores a web app from a snapshot.", + "operationId": "WebApps_RestoreSnapshot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6184,16 +7322,18 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "processId", - "in": "path", - "description": "PID.", + "name": "restoreRequest", + "in": "body", + "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/SnapshotRestoreRequest" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6203,29 +7343,24 @@ } ], "responses": { - "200": { - "description": "Module information returned.", - "schema": { - "$ref": "#/definitions/ProcessModuleInfoCollection" - } + "202": { + "description": "Restore operation started." }, - "404": { - "description": "Process with the specified ID is not running." + "200": { + "description": "Restore operation started." } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { "get": { "tags": [ "WebApps" ], - "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", - "description": "Get process information by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetProcessModule", + "summary": "Get list of siteextensions for a web site, or a deployment slot.", + "description": "Get list of siteextensions for a web site, or a deployment slot.", + "operationId": "WebApps_ListSiteExtensions", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6237,20 +7372,6 @@ "required": true, "type": "string" }, - { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, - { - "name": "baseAddress", - "in": "path", - "description": "Module base address.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6260,25 +7381,28 @@ ], "responses": { "200": { - "description": "Module information returned.", + "description": "SiteExtension information returned.", "schema": { - "$ref": "#/definitions/ProcessModuleInfo" + "$ref": "#/definitions/SiteExtensionInfoCollection" } }, "404": { - "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." + "description": "SiteExtension not found." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": { "get": { "tags": [ "WebApps" ], - "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", - "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListProcessThreads", + "summary": "Get site extension information by its ID for a web site, or a deployment slot.", + "description": "Get site extension information by its ID for a web site, or a deployment slot.", + "operationId": "WebApps_GetSiteExtension", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6291,9 +7415,9 @@ "type": "string" }, { - "name": "processId", + "name": "siteExtensionId", "in": "path", - "description": "PID.", + "description": "Site extension name.", "required": true, "type": "string" }, @@ -6306,28 +7430,23 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "SiteExtension information returned.", "schema": { - "$ref": "#/definitions/ProcessThreadInfoCollection" + "$ref": "#/definitions/SiteExtensionInfo" } }, "404": { - "description": "Process with the specified ID is not running." + "description": "SiteExtension with an ID of {siteExtensionId} is not running." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId}": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", - "description": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetProcessThread", + "summary": "Install site extension on a web site, or a deployment slot.", + "description": "Install site extension on a web site, or a deployment slot.", + "operationId": "WebApps_InstallSiteExtension", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6340,16 +7459,9 @@ "type": "string" }, { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, - { - "name": "threadId", + "name": "siteExtensionId", "in": "path", - "description": "TID.", + "description": "Site extension name.", "required": true, "type": "string" }, @@ -6361,26 +7473,31 @@ } ], "responses": { + "201": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, "200": { - "description": "Thread information returned.", + "description": "Site Extension created.", "schema": { - "$ref": "#/definitions/ProcessThreadInfo" + "$ref": "#/definitions/SiteExtensionInfo" } }, - "404": { - "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." + "429": { + "description": "Site Extension is being installed on another request: Rejecting current request." } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { - "get": { + }, + "x-ms-long-running-operation": true + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Get public certificates for an app or a deployment slot.", - "description": "Get public certificates for an app or a deployment slot.", - "operationId": "WebApps_ListPublicCertificates", + "summary": "Remove a site extension from a web site, or a deployment slot.", + "description": "Remove a site extension from a web site, or a deployment slot.", + "operationId": "WebApps_DeleteSiteExtension", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6388,7 +7505,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", "required": true, "type": "string" }, @@ -6400,32 +7524,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PublicCertificateCollection" - } + "204": { + "description": "SiteExtension terminated." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "SiteExtension with an ID of {siteExtensionId} is not running." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotcopy": { + "post": { "tags": [ "WebApps" ], - "summary": "Get the named public certificate for an app (or deployment slot, if specified).", - "description": "Get the named public certificate for an app (or deployment slot, if specified).", - "operationId": "WebApps_GetPublicCertificate", + "summary": "Copies a deployment slot to another deployment slot of an app.", + "description": "Copies a deployment slot to another deployment slot of an app.", + "operationId": "WebApps_CopyProductionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6438,11 +7553,13 @@ "type": "string" }, { - "name": "publicCertificateName", - "in": "path", - "description": "Public certificate name.", + "name": "copySlotEntity", + "in": "body", + "description": "JSON object that contains the target slot name and site config properties to override the source slot config. See example.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/CsmCopySlotEntity" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6453,26 +7570,23 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PublicCertificate" - } + "description": "OK." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "202": { + "description": "Operation is in progress." } - } - }, - "put": { + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { + "get": { "tags": [ "WebApps" ], - "summary": "Creates a hostname binding for an app.", - "description": "Creates a hostname binding for an app.", - "operationId": "WebApps_CreateOrUpdatePublicCertificate", + "summary": "Gets an app's deployment slots.", + "description": "Gets an app's deployment slots.", + "operationId": "WebApps_ListSlots", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6484,22 +7598,6 @@ "required": true, "type": "string" }, - { - "name": "publicCertificateName", - "in": "path", - "description": "Public certificate name.", - "required": true, - "type": "string" - }, - { - "name": "publicCertificate", - "in": "body", - "description": "Public certificate details. This is the JSON representation of a PublicCertificate object.", - "required": true, - "schema": { - "$ref": "#/definitions/PublicCertificate" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6511,7 +7609,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PublicCertificate" + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" } }, "default": { @@ -6520,15 +7618,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes a hostname binding for an app.", - "description": "Deletes a hostname binding for an app.", - "operationId": "WebApps_DeletePublicCertificate", + "summary": "Gets the details of a web, mobile, or API app.", + "description": "Gets the details of a web, mobile, or API app.", + "operationId": "WebApps_GetSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6541,9 +7644,9 @@ "type": "string" }, { - "name": "publicCertificateName", + "name": "slot", "in": "path", - "description": "Public certificate name.", + "description": "Name of the deployment slot. By default, this API returns the production slot.", "required": true, "type": "string" }, @@ -6556,25 +7659,23 @@ ], "responses": { "200": { - "description": "Successfully deleted hostname binding." + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } }, - "204": { - "description": "Hostname binding does not exist." + "404": { + "description": "Not found." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets the publishing profile for an app (or deployment slot, if specified).", - "description": "Gets the publishing profile for an app (or deployment slot, if specified).", - "operationId": "WebApps_ListPublishingProfileXmlWithSecrets", - "produces": [ - "application/xml" - ], + "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "operationId": "WebApps_CreateOrUpdateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6582,19 +7683,26 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", "required": true, "type": "string" }, { - "name": "publishingProfileOptions", + "name": "siteEnvelope", "in": "body", - "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", + "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { - "$ref": "#/definitions/CsmPublishingProfileOptions" + "$ref": "./CommonDefinitions.json#/definitions/Site" } }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6604,9 +7712,15 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { - "type": "file" + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" } }, "default": { @@ -6615,17 +7729,16 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { - "post": { + }, + "x-ms-long-running-operation": true + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", - "description": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", - "operationId": "WebApps_ResetProductionSlotConfig", + "summary": "Deletes a web, mobile, or API app, or one of the deployment slots.", + "description": "Deletes a web, mobile, or API app, or one of the deployment slots.", + "operationId": "WebApps_DeleteSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6633,53 +7746,27 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of the app to delete.", "required": true, "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { - "post": { - "tags": [ - "WebApps" - ], - "summary": "Restarts an app (or deployment slot, if specified).", - "description": "Restarts an app (or deployment slot, if specified).", - "operationId": "WebApps_Restart", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", + "name": "slot", "in": "path", - "description": "Name of the app.", + "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.", "required": true, "type": "string" }, { - "name": "softRestart", + "name": "deleteMetrics", "in": "query", - "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", + "description": "If true, web app metrics are also deleted.", "type": "boolean" }, { - "name": "synchronous", + "name": "deleteEmptyServerFarm", "in": "query", - "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", + "description": "Specify true if the App Service plan will be empty after app deletion and you want to delete the empty App Service plan. By default, the empty App Service plan is not deleted.", "type": "boolean" }, { @@ -6691,19 +7778,23 @@ ], "responses": { "200": { - "description": "Successfully restarted app." + "description": "Successfully deleted web app." + }, + "204": { + "description": "Successfully deleted web app." + }, + "404": { + "description": "Web app not found." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": { - "post": { + }, + "patch": { "tags": [ "WebApps" ], - "summary": "Restores an app from a backup blob in Azure Storage.", - "description": "Restores an app from a backup blob in Azure Storage.", - "operationId": "WebApps_RestoreFromBackupBlob", + "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "operationId": "WebApps_UpdateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6711,19 +7802,26 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", "required": true, "type": "string" }, { - "name": "request", + "name": "siteEnvelope", "in": "body", - "description": "Information on restore request .", + "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/SitePatchResource" } }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6732,24 +7830,35 @@ } ], "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, "202": { - "description": "Restore operation started." + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } }, - "200": { - "description": "Restore operation started." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { + "get": { "tags": [ "WebApps" - ], - "summary": "Restores a deleted web app to this web app.", - "description": "Restores a deleted web app to this web app.", - "operationId": "WebApps_RestoreFromDeletedApp", + ], + "summary": "Analyze a custom hostname.", + "description": "Analyze a custom hostname.", + "operationId": "WebApps_AnalyzeCustomHostnameSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6762,13 +7871,17 @@ "type": "string" }, { - "name": "restoreRequest", - "in": "body", - "description": "Deleted web app restore information.", + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, - "schema": { - "$ref": "#/definitions/DeletedAppRestoreRequest" - } + "type": "string" + }, + { + "name": "hostName", + "in": "query", + "description": "Custom hostname.", + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6778,24 +7891,29 @@ } ], "responses": { - "202": { - "description": "Restore operation started." - }, "200": { - "description": "Restore operation started." + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomHostnameAnalysisResult" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { "post": { "tags": [ "WebApps" ], - "summary": "Restores a web app from a snapshot.", - "description": "Restores a web app from a snapshot.", - "operationId": "WebApps_RestoreSnapshot", + "summary": "Applies the configuration settings from the target slot onto the current slot.", + "description": "Applies the configuration settings from the target slot onto the current slot.", + "operationId": "WebApps_ApplySlotConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6803,19 +7921,26 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "restoreRequest", + "name": "slotSwapEntity", "in": "body", - "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "description": "JSON object that contains the target slot name. See example.", "required": true, "schema": { - "$ref": "#/definitions/SnapshotRestoreRequest" + "$ref": "#/definitions/CsmSlotEntity" } }, + { + "name": "slot", + "in": "path", + "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6824,24 +7949,20 @@ } ], "responses": { - "202": { - "description": "Restore operation started." - }, "200": { - "description": "Restore operation started." + "description": "OK." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { + "post": { "tags": [ "WebApps" ], - "summary": "Get list of siteextensions for a web site, or a deployment slot.", - "description": "Get list of siteextensions for a web site, or a deployment slot.", - "operationId": "WebApps_ListSiteExtensions", + "summary": "Creates a backup of an app.", + "description": "Creates a backup of an app.", + "operationId": "WebApps_BackupSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6849,7 +7970,23 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Backup configuration. You can use the JSON response from the POST action as input here.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.", "required": true, "type": "string" }, @@ -6862,28 +7999,28 @@ ], "responses": { "200": { - "description": "SiteExtension information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/SiteExtensionInfoCollection" + "$ref": "#/definitions/BackupItem" } }, - "404": { - "description": "SiteExtension not found." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { "get": { "tags": [ "WebApps" ], - "summary": "Get site extension information by its ID for a web site, or a deployment slot.", - "description": "Get site extension information by its ID for a web site, or a deployment slot.", - "operationId": "WebApps_GetSiteExtension", + "summary": "Gets existing backups of an app.", + "description": "Gets existing backups of an app.", + "operationId": "WebApps_ListBackupsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6891,14 +8028,14 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteExtensionId", + "name": "slot", "in": "path", - "description": "Site extension name.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.", "required": true, "type": "string" }, @@ -6911,23 +8048,31 @@ ], "responses": { "200": { - "description": "SiteExtension information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/SiteExtensionInfo" + "$ref": "#/definitions/BackupItemCollection" } }, - "404": { - "description": "SiteExtension with an ID of {siteExtensionId} is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Install site extension on a web site, or a deployment slot.", - "description": "Install site extension on a web site, or a deployment slot.", - "operationId": "WebApps_InstallSiteExtension", + "summary": "Gets a backup of an app by its ID.", + "description": "Gets a backup of an app by its ID.", + "operationId": "WebApps_GetBackupStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6935,14 +8080,21 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteExtensionId", + "name": "backupId", "in": "path", - "description": "Site extension name.", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.", "required": true, "type": "string" }, @@ -6954,31 +8106,27 @@ } ], "responses": { - "201": { - "description": "Site Extension created.", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/SiteExtensionInfo" + "$ref": "#/definitions/BackupItem" } }, - "200": { - "description": "Site Extension created.", + "default": { + "description": "App Service error response.", "schema": { - "$ref": "#/definitions/SiteExtensionInfo" + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } - }, - "429": { - "description": "Site Extension is being installed on another request: Rejecting current request." } - }, - "x-ms-long-running-operation": true + } }, "delete": { "tags": [ "WebApps" ], - "summary": "Remove a site extension from a web site, or a deployment slot.", - "description": "Remove a site extension from a web site, or a deployment slot.", - "operationId": "WebApps_DeleteSiteExtension", + "summary": "Deletes a backup of an app by its ID.", + "description": "Deletes a backup of an app by its ID.", + "operationId": "WebApps_DeleteBackupSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6986,14 +8134,21 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteExtensionId", + "name": "backupId", "in": "path", - "description": "Site extension name.", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.", "required": true, "type": "string" }, @@ -7005,23 +8160,23 @@ } ], "responses": { - "204": { - "description": "SiteExtension terminated." + "200": { + "description": "Successfully deleted web app backup item." }, "404": { - "description": "SiteExtension with an ID of {siteExtensionId} is not running." + "description": "Web app backup item does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets an app's deployment slots.", - "description": "Gets an app's deployment slots.", - "operationId": "WebApps_ListSlots", + "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", + "description": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", + "operationId": "WebApps_ListBackupStatusSecretsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7029,7 +8184,30 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "ID of backup.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -7044,7 +8222,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + "$ref": "#/definitions/BackupItem" } }, "default": { @@ -7053,20 +8231,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets the details of a web, mobile, or API app.", - "description": "Gets the details of a web, mobile, or API app.", - "operationId": "WebApps_GetSlot", + "summary": "Restores a specific backup to another app (or deployment slot, if specified).", + "description": "Restores a specific backup to another app (or deployment slot, if specified).", + "operationId": "WebApps_RestoreSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7078,10 +8253,26 @@ "required": true, "type": "string" }, + { + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request .", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. By default, this API returns the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", "required": true, "type": "string" }, @@ -7093,24 +8284,24 @@ } ], "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" - } + "202": { + "description": "Restore operation started." }, - "404": { - "description": "Not found." + "200": { + "description": "Restore operation started." } - } - }, - "put": { + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": { + "get": { "tags": [ "WebApps" ], - "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", - "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", - "operationId": "WebApps_CreateOrUpdateSlot", + "summary": "List the configurations of an app", + "description": "List the configurations of an app", + "operationId": "WebApps_ListConfigurationsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7118,23 +8309,14 @@ { "name": "name", "in": "path", - "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", + "description": "Name of the app.", "required": true, "type": "string" }, - { - "name": "siteEnvelope", - "in": "body", - "description": "A JSON representation of the app properties. See example.", - "required": true, - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -7147,15 +8329,9 @@ ], "responses": { "200": { - "description": "OK.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" - } - }, - "202": { - "description": "Asynchronous operation in progress.", + "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" + "$ref": "#/definitions/SiteConfigResourceCollection" } }, "default": { @@ -7165,15 +8341,19 @@ } } }, - "x-ms-long-running-operation": true - }, - "delete": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { + "put": { "tags": [ "WebApps" ], - "summary": "Deletes a web, mobile, or API app, or one of the deployment slots.", - "description": "Deletes a web, mobile, or API app, or one of the deployment slots.", - "operationId": "WebApps_DeleteSlot", + "summary": "Replaces the application settings of an app.", + "description": "Replaces the application settings of an app.", + "operationId": "WebApps_UpdateApplicationSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7181,29 +8361,26 @@ { "name": "name", "in": "path", - "description": "Name of the app to delete.", + "description": "Name of the app.", "required": true, "type": "string" }, + { + "name": "appSettings", + "in": "body", + "description": "Application settings of the app.", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.", "required": true, "type": "string" }, - { - "name": "deleteMetrics", - "in": "query", - "description": "If true, web app metrics are also deleted.", - "type": "boolean" - }, - { - "name": "deleteEmptyServerFarm", - "in": "query", - "description": "Specify true if the App Service plan will be empty after app deletion and you want to delete the empty App Service plan. By default, the empty App Service plan is not deleted.", - "type": "boolean" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7213,23 +8390,28 @@ ], "responses": { "200": { - "description": "Successfully deleted web app." - }, - "204": { - "description": "Successfully deleted web app." + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } }, - "404": { - "description": "Web app not found." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", - "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", - "operationId": "WebApps_UpdateSlot", + "summary": "Gets the application settings of an app.", + "description": "Gets the application settings of an app.", + "operationId": "WebApps_ListApplicationSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7237,23 +8419,14 @@ { "name": "name", "in": "path", - "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", + "description": "Name of the app.", "required": true, "type": "string" }, - { - "name": "siteEnvelope", - "in": "body", - "description": "A JSON representation of the app properties. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/SitePatchResource" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.", "required": true, "type": "string" }, @@ -7266,15 +8439,9 @@ ], "responses": { "200": { - "description": "OK.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" - } - }, - "202": { - "description": "Asynchronous operation in progress.", + "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -7286,14 +8453,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { + "put": { "tags": [ "WebApps" ], - "summary": "Analyze a custom hostname.", - "description": "Analyze a custom hostname.", - "operationId": "WebApps_AnalyzeCustomHostnameSlot", + "summary": "Updates the Authentication / Authorization settings associated with web app.", + "description": "Updates the Authentication / Authorization settings associated with web app.", + "operationId": "WebApps_UpdateAuthSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7305,6 +8472,15 @@ "required": true, "type": "string" }, + { + "name": "siteAuthSettings", + "in": "body", + "description": "Auth settings associated with web app.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, { "name": "slot", "in": "path", @@ -7312,12 +8488,6 @@ "required": true, "type": "string" }, - { - "name": "hostName", - "in": "query", - "description": "Custom hostname.", - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7329,7 +8499,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CustomHostnameAnalysisResult" + "$ref": "#/definitions/SiteAuthSettings" } }, "default": { @@ -7341,14 +8511,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { "post": { "tags": [ "WebApps" ], - "summary": "Applies the configuration settings from the target slot onto the current slot.", - "description": "Applies the configuration settings from the target slot onto the current slot.", - "operationId": "WebApps_ApplySlotConfigurationSlot", + "summary": "Gets the Authentication/Authorization settings of an app.", + "description": "Gets the Authentication/Authorization settings of an app.", + "operationId": "WebApps_GetAuthSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7360,19 +8530,10 @@ "required": true, "type": "string" }, - { - "name": "slotSwapEntity", - "in": "body", - "description": "JSON object that contains the target slot name. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } - }, { "name": "slot", "in": "path", - "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.", "required": true, "type": "string" }, @@ -7385,19 +8546,28 @@ ], "responses": { "200": { - "description": "OK." + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": { + "put": { "tags": [ "WebApps" ], - "summary": "Creates a backup of an app.", - "description": "Creates a backup of an app.", - "operationId": "WebApps_BackupSlot", + "summary": "Updates the Azure storage account configurations of an app.", + "description": "Updates the Azure storage account configurations of an app.", + "operationId": "WebApps_UpdateAzureStorageAccountsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7410,18 +8580,18 @@ "type": "string" }, { - "name": "request", + "name": "azureStorageAccounts", "in": "body", - "description": "Backup configuration. You can use the JSON response from the POST action as input here.", + "description": "Azure storage accounts of the app.", "required": true, "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", "required": true, "type": "string" }, @@ -7436,7 +8606,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, "default": { @@ -7448,14 +8618,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets existing backups of an app.", - "description": "Gets existing backups of an app.", - "operationId": "WebApps_ListBackupsSlot", + "summary": "Gets the Azure storage account configurations of an app.", + "description": "Gets the Azure storage account configurations of an app.", + "operationId": "WebApps_ListAzureStorageAccountsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7470,7 +8640,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", "required": true, "type": "string" }, @@ -7485,7 +8655,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItemCollection" + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, "default": { @@ -7494,20 +8664,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { + "put": { "tags": [ "WebApps" ], - "summary": "Gets a backup of an app by its ID.", - "description": "Gets a backup of an app by its ID.", - "operationId": "WebApps_GetBackupStatusSlot", + "summary": "Updates the backup configuration of an app.", + "description": "Updates the backup configuration of an app.", + "operationId": "WebApps_UpdateBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7520,16 +8687,18 @@ "type": "string" }, { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", + "name": "request", + "in": "body", + "description": "Edited backup configuration.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/BackupRequest" + } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.", "required": true, "type": "string" }, @@ -7544,7 +8713,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/BackupRequest" } }, "default": { @@ -7559,9 +8728,9 @@ "tags": [ "WebApps" ], - "summary": "Deletes a backup of an app by its ID.", - "description": "Deletes a backup of an app by its ID.", - "operationId": "WebApps_DeleteBackupSlot", + "summary": "Deletes the backup configuration of an app.", + "description": "Deletes the backup configuration of an app.", + "operationId": "WebApps_DeleteBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7573,17 +8742,10 @@ "required": true, "type": "string" }, - { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", - "required": true, - "type": "string" - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot.", "required": true, "type": "string" }, @@ -7596,22 +8758,19 @@ ], "responses": { "200": { - "description": "Successfully deleted web app backup item." - }, - "404": { - "description": "Web app backup item does not exist." + "description": "Successfully deleted backup configuration." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { "post": { "tags": [ "WebApps" ], - "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", - "description": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", - "operationId": "WebApps_ListBackupStatusSecretsSlot", + "summary": "Gets the backup configuration of an app.", + "description": "Gets the backup configuration of an app.", + "operationId": "WebApps_GetBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7619,30 +8778,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "ID of backup.", + "description": "Name of the app.", "required": true, "type": "string" }, - { - "name": "request", - "in": "body", - "description": "Information on backup request.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.", "required": true, "type": "string" }, @@ -7657,7 +8800,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/BackupRequest" } }, "default": { @@ -7669,14 +8812,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { + "put": { "tags": [ "WebApps" ], - "summary": "Restores a specific backup to another app (or deployment slot, if specified).", - "description": "Restores a specific backup to another app (or deployment slot, if specified).", - "operationId": "WebApps_RestoreSlot", + "summary": "Replaces the connection strings of an app.", + "description": "Replaces the connection strings of an app.", + "operationId": "WebApps_UpdateConnectionStringsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7689,25 +8832,18 @@ "type": "string" }, { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", - "required": true, - "type": "string" - }, - { - "name": "request", + "name": "connectionStrings", "in": "body", - "description": "Information on restore request .", + "description": "Connection strings of the app or deployment slot. See example.", "required": true, "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/ConnectionStringDictionary" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.", "required": true, "type": "string" }, @@ -7719,24 +8855,29 @@ } ], "responses": { - "202": { - "description": "Restore operation started." - }, "200": { - "description": "Restore operation started." + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "List the configurations of an app", - "description": "List the configurations of an app", - "operationId": "WebApps_ListConfigurationsSlot", + "summary": "Gets the connection strings of an app.", + "description": "Gets the connection strings of an app.", + "operationId": "WebApps_ListConnectionStringsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7751,7 +8892,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.", "required": true, "type": "string" }, @@ -7766,7 +8907,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResourceCollection" + "$ref": "#/definitions/ConnectionStringDictionary" } }, "default": { @@ -7775,20 +8916,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { + "get": { "tags": [ "WebApps" ], - "summary": "Replaces the application settings of an app.", - "description": "Replaces the application settings of an app.", - "operationId": "WebApps_UpdateApplicationSettingsSlot", + "summary": "Gets the logging configuration of an app.", + "description": "Gets the logging configuration of an app.", + "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7800,19 +8938,10 @@ "required": true, "type": "string" }, - { - "name": "appSettings", - "in": "body", - "description": "Application settings of the app.", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.", "required": true, "type": "string" }, @@ -7827,7 +8956,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteLogsConfig" } }, "default": { @@ -7837,16 +8966,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets the application settings of an app.", - "description": "Gets the application settings of an app.", - "operationId": "WebApps_ListApplicationSettingsSlot", + "summary": "Updates the logging configuration of an app.", + "description": "Updates the logging configuration of an app.", + "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7858,10 +8985,19 @@ "required": true, "type": "string" }, + { + "name": "siteLogsConfig", + "in": "body", + "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.", "required": true, "type": "string" }, @@ -7876,7 +9012,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteLogsConfig" } }, "default": { @@ -7888,14 +9024,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { "put": { "tags": [ "WebApps" ], - "summary": "Updates the Authentication / Authorization settings associated with web app.", - "description": "Updates the Authentication / Authorization settings associated with web app.", - "operationId": "WebApps_UpdateAuthSettingsSlot", + "summary": "Replaces the metadata of an app.", + "description": "Replaces the metadata of an app.", + "operationId": "WebApps_UpdateMetadataSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7903,23 +9039,23 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteAuthSettings", + "name": "metadata", "in": "body", - "description": "Auth settings associated with web app.", + "description": "Edited metadata of the app or deployment slot. See example.", "required": true, "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/StringDictionary" } }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.", "required": true, "type": "string" }, @@ -7934,7 +9070,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -7946,14 +9082,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the Authentication/Authorization settings of an app.", - "description": "Gets the Authentication/Authorization settings of an app.", - "operationId": "WebApps_GetAuthSettingsSlot", + "summary": "Gets the metadata of an app.", + "description": "Gets the metadata of an app.", + "operationId": "WebApps_ListMetadataSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7968,7 +9104,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.", "required": true, "type": "string" }, @@ -7983,7 +9119,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -7995,14 +9131,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates the Azure storage account configurations of an app.", - "description": "Updates the Azure storage account configurations of an app.", - "operationId": "WebApps_UpdateAzureStorageAccountsSlot", + "summary": "Gets the Git/FTP publishing credentials of an app.", + "description": "Gets the Git/FTP publishing credentials of an app.", + "operationId": "WebApps_ListPublishingCredentialsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8014,19 +9150,10 @@ "required": true, "type": "string" }, - { - "name": "azureStorageAccounts", - "in": "body", - "description": "Azure storage accounts of the app.", - "required": true, - "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot.", "required": true, "type": "string" }, @@ -8041,7 +9168,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + "$ref": "./CommonDefinitions.json#/definitions/User" } }, "default": { @@ -8050,17 +9177,18 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { + "put": { "tags": [ "WebApps" ], - "summary": "Gets the Azure storage account configurations of an app.", - "description": "Gets the Azure storage account configurations of an app.", - "operationId": "WebApps_ListAzureStorageAccountsSlot", + "summary": "Updates the Push settings associated with web app.", + "description": "Updates the Push settings associated with web app.", + "operationId": "WebApps_UpdateSitePushSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8068,14 +9196,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, + { + "name": "pushSettings", + "in": "body", + "description": "Push settings associated with web app.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8090,7 +9227,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" } }, "default": { @@ -8102,14 +9239,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates the backup configuration of an app.", - "description": "Updates the backup configuration of an app.", - "operationId": "WebApps_UpdateBackupConfigurationSlot", + "summary": "Gets the Push settings associated with web app.", + "description": "Gets the Push settings associated with web app.", + "operationId": "WebApps_ListSitePushSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8117,23 +9254,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, - { - "name": "request", - "in": "body", - "description": "Edited backup configuration.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8148,7 +9276,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" } }, "default": { @@ -8158,14 +9286,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes the backup configuration of an app.", - "description": "Deletes the backup configuration of an app.", - "operationId": "WebApps_DeleteBackupConfigurationSlot", + "summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", + "description": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", + "operationId": "WebApps_GetConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8180,7 +9310,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8193,19 +9323,26 @@ ], "responses": { "200": { - "description": "Successfully deleted backup configuration." + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets the backup configuration of an app.", - "description": "Gets the backup configuration of an app.", - "operationId": "WebApps_GetBackupConfigurationSlot", + "summary": "Updates the configuration of an app.", + "description": "Updates the configuration of an app.", + "operationId": "WebApps_CreateOrUpdateConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8217,10 +9354,19 @@ "required": true, "type": "string" }, + { + "name": "siteConfig", + "in": "body", + "description": "JSON representation of a SiteConfig object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", "required": true, "type": "string" }, @@ -8235,7 +9381,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8245,16 +9391,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { - "put": { + }, + "patch": { "tags": [ "WebApps" ], - "summary": "Replaces the connection strings of an app.", - "description": "Replaces the connection strings of an app.", - "operationId": "WebApps_UpdateConnectionStringsSlot", + "summary": "Updates the configuration of an app.", + "description": "Updates the configuration of an app.", + "operationId": "WebApps_UpdateConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8267,18 +9411,18 @@ "type": "string" }, { - "name": "connectionStrings", + "name": "siteConfig", "in": "body", - "description": "Connection strings of the app or deployment slot. See example.", + "description": "JSON representation of a SiteConfig object. See example.", "required": true, "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteConfigResource" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", "required": true, "type": "string" }, @@ -8293,7 +9437,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8305,14 +9449,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": { + "get": { "tags": [ "WebApps" ], - "summary": "Gets the connection strings of an app.", - "description": "Gets the connection strings of an app.", - "operationId": "WebApps_ListConnectionStringsSlot", + "summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.", + "description": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.", + "operationId": "WebApps_ListConfigurationSnapshotInfoSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8327,7 +9471,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8342,7 +9486,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection" } }, "default": { @@ -8351,17 +9495,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the logging configuration of an app.", - "description": "Gets the logging configuration of an app.", - "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot", + "summary": "Gets a snapshot of the configuration of an app at a previous point in time.", + "description": "Gets a snapshot of the configuration of an app at a previous point in time.", + "operationId": "WebApps_GetConfigurationSnapshotSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8373,10 +9520,17 @@ "required": true, "type": "string" }, + { + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", + "required": true, + "type": "string" + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8391,7 +9545,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8401,14 +9555,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates the logging configuration of an app.", - "description": "Updates the logging configuration of an app.", - "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", + "summary": "Reverts the configuration of an app to a previous snapshot.", + "description": "Reverts the configuration of an app to a previous snapshot.", + "operationId": "WebApps_RecoverSiteConfigurationSnapshotSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8421,18 +9577,16 @@ "type": "string" }, { - "name": "siteLogsConfig", - "in": "body", - "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", "required": true, - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8444,29 +9598,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "No Content" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": { + "post": { "tags": [ "WebApps" ], - "summary": "Replaces the metadata of an app.", - "description": "Replaces the metadata of an app.", - "operationId": "WebApps_UpdateMetadataSlot", + "summary": "Gets the last lines of docker logs for the given site", + "description": "Gets the last lines of docker logs for the given site", + "operationId": "WebApps_GetWebSiteContainerLogsSlot", + "produces": [ + "application/octet-stream" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8474,23 +9622,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, - { - "name": "metadata", - "in": "body", - "description": "Edited metadata of the app or deployment slot. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8502,29 +9641,29 @@ } ], "responses": { + "204": { + "description": "No Content" + }, "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + "type": "file" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the metadata of an app.", - "description": "Gets the metadata of an app.", - "operationId": "WebApps_ListMetadataSlot", + "summary": "Gets the ZIP archived docker log files for the given site", + "description": "Gets the ZIP archived docker log files for the given site", + "operationId": "WebApps_GetContainerLogsZipSlot", + "produces": [ + "application/zip" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8532,14 +9671,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8551,29 +9690,26 @@ } ], "responses": { + "204": { + "description": "No Content" + }, "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + "type": "file" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { + "get": { "tags": [ "WebApps" ], - "summary": "Gets the Git/FTP publishing credentials of an app.", - "description": "Gets the Git/FTP publishing credentials of an app.", - "operationId": "WebApps_ListPublishingCredentialsSlot", + "summary": "List continuous web jobs for an app, or a deployment slot.", + "description": "List continuous web jobs for an app, or a deployment slot.", + "operationId": "WebApps_ListContinuousWebJobsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8581,14 +9717,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8603,7 +9739,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/User" + "$ref": "#/definitions/ContinuousWebJobCollection" } }, "default": { @@ -8613,17 +9749,19 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates the Push settings associated with web app.", - "description": "Updates the Push settings associated with web app.", - "operationId": "WebApps_UpdateSitePushSettingsSlot", + "summary": "Gets a continuous web job by its ID for an app, or a deployment slot.", + "description": "Gets a continuous web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetContinuousWebJobSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8631,23 +9769,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "pushSettings", - "in": "body", - "description": "Push settings associated with web app.", + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PushSettings" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8660,28 +9796,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Found continuous web job.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + "$ref": "#/definitions/ContinuousWebJob" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Continuous web job does not exist." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { - "post": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets the Push settings associated with web app.", - "description": "Gets the Push settings associated with web app.", - "operationId": "WebApps_ListSitePushSettingsSlot", + "summary": "Delete a continuous web job by its ID for an app, or a deployment slot.", + "description": "Delete a continuous web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteContinuousWebJobSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8689,14 +9820,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8709,28 +9847,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PushSettings" - } + "description": "Successfully deleted continuous web job." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Continuous web job does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", - "description": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", - "operationId": "WebApps_GetConfigurationSlot", + "summary": "Start a continuous web job for an app, or a deployment slot.", + "description": "Start a continuous web job for an app, or a deployment slot.", + "operationId": "WebApps_StartContinuousWebJobSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8738,14 +9870,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8758,26 +9897,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "description": "Found continuous web job." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Continuous web job does not exist." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates the configuration of an app.", - "description": "Updates the configuration of an app.", - "operationId": "WebApps_CreateOrUpdateConfigurationSlot", + "summary": "Stop a continuous web job for an app, or a deployment slot.", + "description": "Stop a continuous web job for an app, or a deployment slot.", + "operationId": "WebApps_StopContinuousWebJobSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8785,23 +9920,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "siteConfig", - "in": "body", - "description": "JSON representation of a SiteConfig object. See example.", + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8814,26 +9947,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "description": "Found continuous web job." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Continuous web job does not exist." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates the configuration of an app.", - "description": "Updates the configuration of an app.", - "operationId": "WebApps_UpdateConfigurationSlot", + "summary": "List deployments for an app, or a deployment slot.", + "description": "List deployments for an app, or a deployment slot.", + "operationId": "WebApps_ListDeploymentsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8845,19 +9974,10 @@ "required": true, "type": "string" }, - { - "name": "siteConfig", - "in": "body", - "description": "JSON representation of a SiteConfig object. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, @@ -8872,7 +9992,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/DeploymentCollection" } }, "default": { @@ -8881,17 +10001,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.", - "description": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.", - "operationId": "WebApps_ListConfigurationSnapshotInfoSlot", + "summary": "Get a deployment by its ID for an app, or a deployment slot.", + "description": "Get a deployment by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetDeploymentSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8903,10 +10026,17 @@ "required": true, "type": "string" }, + { + "name": "id", + "in": "path", + "description": "Deployment ID.", + "required": true, + "type": "string" + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.", "required": true, "type": "string" }, @@ -8921,7 +10051,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection" + "$ref": "#/definitions/Deployment" } }, "default": { @@ -8930,20 +10060,15 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets a snapshot of the configuration of an app at a previous point in time.", - "description": "Gets a snapshot of the configuration of an app at a previous point in time.", - "operationId": "WebApps_GetConfigurationSnapshotSlot", + "summary": "Create a deployment for an app, or a deployment slot.", + "description": "Create a deployment for an app, or a deployment slot.", + "operationId": "WebApps_CreateDeploymentSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8956,19 +10081,28 @@ "type": "string" }, { - "name": "snapshotId", + "name": "id", "in": "path", - "description": "The ID of the snapshot to read.", + "description": "ID of an existing deployment.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.", "required": true, "type": "string" }, + { + "name": "deployment", + "in": "body", + "description": "Deployment details.", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -8980,7 +10114,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/Deployment" } }, "default": { @@ -8990,16 +10124,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": { - "post": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Reverts the configuration of an app to a previous snapshot.", - "description": "Reverts the configuration of an app to a previous snapshot.", - "operationId": "WebApps_RecoverSiteConfigurationSnapshotSlot", + "summary": "Delete a deployment by its ID for an app, or a deployment slot.", + "description": "Delete a deployment by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteDeploymentSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9012,16 +10144,16 @@ "type": "string" }, { - "name": "snapshotId", + "name": "id", "in": "path", - "description": "The ID of the snapshot to read.", + "description": "Deployment ID.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -9033,23 +10165,23 @@ } ], "responses": { + "200": { + "description": "Successfully deleted deployment." + }, "204": { - "description": "No Content" + "description": "Deployment does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": { + "get": { "tags": [ "WebApps" ], - "summary": "Gets the last lines of docker logs for the given site", - "description": "Gets the last lines of docker logs for the given site", - "operationId": "WebApps_GetWebSiteContainerLogsSlot", - "produces": [ - "application/octet-stream" - ], + "summary": "List deployment log for specific deployment for an app, or a deployment slot.", + "description": "List deployment log for specific deployment for an app, or a deployment slot.", + "operationId": "WebApps_ListDeploymentLogSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9057,14 +10189,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, @@ -9076,29 +10215,29 @@ } ], "responses": { - "204": { - "description": "No Content" - }, "200": { "description": "OK", "schema": { - "type": "file" + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the ZIP archived docker log files for the given site", - "description": "Gets the ZIP archived docker log files for the given site", - "operationId": "WebApps_GetContainerLogsZipSlot", - "produces": [ - "application/zip" - ], + "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "description": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "operationId": "WebApps_DiscoverBackupSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9106,14 +10245,23 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, + { + "name": "request", + "in": "body", + "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.", "required": true, "type": "string" }, @@ -9125,26 +10273,29 @@ } ], "responses": { - "204": { - "description": "No Content" - }, "200": { "description": "OK", "schema": { - "type": "file" + "$ref": "#/definitions/RestoreRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { "get": { "tags": [ "WebApps" ], - "summary": "List continuous web jobs for an app, or a deployment slot.", - "description": "List continuous web jobs for an app, or a deployment slot.", - "operationId": "WebApps_ListContinuousWebJobsSlot", + "summary": "Lists ownership identifiers for domain associated with web app.", + "description": "Lists ownership identifiers for domain associated with web app.", + "operationId": "WebApps_ListDomainOwnershipIdentifiersSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9152,14 +10303,14 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9174,7 +10325,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ContinuousWebJobCollection" + "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection" } }, "default": { @@ -9189,14 +10340,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a continuous web job by its ID for an app, or a deployment slot.", - "description": "Gets a continuous web job by its ID for an app, or a deployment slot.", - "operationId": "WebApps_GetContinuousWebJobSlot", + "summary": "Get domain ownership identifier for web app.", + "description": "Get domain ownership identifier for web app.", + "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9204,21 +10355,21 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "webJobName", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "Name of Web Job.", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9231,23 +10382,26 @@ ], "responses": { "200": { - "description": "Found continuous web job.", + "description": "OK", "schema": { - "$ref": "#/definitions/ContinuousWebJob" + "$ref": "./CommonDefinitions.json#/definitions/Identifier" } }, - "404": { - "description": "Continuous web job does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } }, - "delete": { + "put": { "tags": [ "WebApps" ], - "summary": "Delete a continuous web job by its ID for an app, or a deployment slot.", - "description": "Delete a continuous web job by its ID for an app, or a deployment slot.", - "operationId": "WebApps_DeleteContinuousWebJobSlot", + "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "description": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9255,21 +10409,30 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "webJobName", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "Name of Web Job.", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9282,22 +10445,26 @@ ], "responses": { "200": { - "description": "Successfully deleted continuous web job." + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } }, - "204": { - "description": "Continuous web job does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": { - "post": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Start a continuous web job for an app, or a deployment slot.", - "description": "Start a continuous web job for an app, or a deployment slot.", - "operationId": "WebApps_StartContinuousWebJobSlot", + "summary": "Deletes a domain ownership identifier for a web app.", + "description": "Deletes a domain ownership identifier for a web app.", + "operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9305,21 +10472,21 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "webJobName", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "Name of Web Job.", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9332,22 +10499,20 @@ ], "responses": { "200": { - "description": "Found continuous web job." + "description": "Successfully deleted domain ownership identifier." }, - "404": { - "description": "Continuous web job does not exist." + "204": { + "description": "Domain ownership identifier does not exist." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": { - "post": { + }, + "patch": { "tags": [ "WebApps" ], - "summary": "Stop a continuous web job for an app, or a deployment slot.", - "description": "Stop a continuous web job for an app, or a deployment slot.", - "operationId": "WebApps_StopContinuousWebJobSlot", + "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "description": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "operationId": "WebApps_UpdateDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9355,21 +10520,30 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "webJobName", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "Name of Web Job.", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9382,22 +10556,28 @@ ], "responses": { "200": { - "description": "Found continuous web job." + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } }, - "404": { - "description": "Continuous web job does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], - "summary": "List deployments for an app, or a deployment slot.", - "description": "List deployments for an app, or a deployment slot.", - "operationId": "WebApps_ListDeploymentsSlot", + "summary": "Get the status of the last MSDeploy operation.", + "description": "Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9405,14 +10585,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -9427,7 +10607,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DeploymentCollection" + "$ref": "#/definitions/MSDeployStatus" } }, "default": { @@ -9436,20 +10616,15 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Get a deployment by its ID for an app, or a deployment slot.", - "description": "Get a deployment by its ID for an app, or a deployment slot.", - "operationId": "WebApps_GetDeploymentSlot", + "summary": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateMSDeployOperationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9457,23 +10632,25 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "id", + "name": "slot", "in": "path", - "description": "Deployment ID.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.", + "name": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MSDeploy" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -9483,27 +10660,27 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - "default": { - "description": "App Service error response.", + "201": { + "description": "Deployment is scheduled.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + "$ref": "#/definitions/MSDeployStatus" } + }, + "409": { + "description": "Another deployment is in progress." } - } - }, - "put": { + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": { + "get": { "tags": [ "WebApps" ], - "summary": "Create a deployment for an app, or a deployment slot.", - "description": "Create a deployment for an app, or a deployment slot.", - "operationId": "WebApps_CreateDeploymentSlot", + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployLogSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9511,33 +10688,17 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "ID of an existing deployment.", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, - { - "name": "deployment", - "in": "body", - "description": "Deployment details.", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -9547,26 +10708,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "MSDeploy log returned.", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/MSDeployLog" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "MSDeploy log not found." } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": { + "get": { "tags": [ "WebApps" ], - "summary": "Delete a deployment by its ID for an app, or a deployment slot.", - "description": "Delete a deployment by its ID for an app, or a deployment slot.", - "operationId": "WebApps_DeleteDeploymentSlot", + "summary": "List the functions for a web site, or a deployment slot.", + "description": "List the functions for a web site, or a deployment slot.", + "operationId": "WebApps_ListInstanceFunctionsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9574,14 +10734,7 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Deployment ID.", + "description": "Site name.", "required": true, "type": "string" }, @@ -9601,22 +10754,28 @@ ], "responses": { "200": { - "description": "Successfully deleted deployment." + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelopeCollection" + } }, - "204": { - "description": "Deployment does not exist." + "404": { + "description": "Function with an ID of {functionName} is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": { "get": { "tags": [ "WebApps" ], - "summary": "List deployment log for specific deployment for an app, or a deployment slot.", - "description": "List deployment log for specific deployment for an app, or a deployment slot.", - "operationId": "WebApps_ListDeploymentLogSlot", + "summary": "Fetch a short lived token that can be exchanged for a master key.", + "description": "Fetch a short lived token that can be exchanged for a master key.", + "operationId": "WebApps_GetFunctionsAdminTokenSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9624,21 +10783,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -9653,7 +10805,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Deployment" + "type": "string" } }, "default": { @@ -9665,14 +10817,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", - "description": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", - "operationId": "WebApps_DiscoverBackupSlot", + "summary": "Get function information by its ID for web site, or a deployment slot.", + "description": "Get function information by its ID for web site, or a deployment slot.", + "operationId": "WebApps_GetInstanceFunctionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9680,23 +10832,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "request", - "in": "body", - "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", + "name": "functionName", + "in": "path", + "description": "Function name.", "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -9709,28 +10859,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function information returned.", "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/FunctionEnvelope" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Function with an name of {functionName} does not exist." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Lists ownership identifiers for domain associated with web app.", - "description": "Lists ownership identifiers for domain associated with web app.", - "operationId": "WebApps_ListDomainOwnershipIdentifiersSlot", + "summary": "Create function for web site, or a deployment slot.", + "description": "Create function for web site, or a deployment slot.", + "operationId": "WebApps_CreateInstanceFunctionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9738,17 +10883,33 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, + { + "name": "function_envelope", + "in": "body", + "description": "Function details.", + "required": true, + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -9757,10 +10918,10 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Function created.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection" + "$ref": "#/definitions/FunctionEnvelope" } }, "default": { @@ -9770,19 +10931,15 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { - "get": { + "x-ms-long-running-operation": true + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Get domain ownership identifier for web app.", - "description": "Get domain ownership identifier for web app.", - "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", + "summary": "Delete a function for web site, or a deployment slot.", + "description": "Delete a function for web site, or a deployment slot.", + "operationId": "WebApps_DeleteInstanceFunctionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9790,21 +10947,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "domainOwnershipIdentifierName", + "name": "functionName", "in": "path", - "description": "Name of domain ownership identifier.", + "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -9816,27 +10973,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" - } + "204": { + "description": "Function deleted." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Function does not exist." } } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}": { "put": { "tags": [ "WebApps" ], - "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", - "description": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", - "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot", + "summary": "Add or update a function secret.", + "description": "Add or update a function secret.", + "operationId": "WebApps_CreateOrUpdateFunctionSecretSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9844,33 +10997,40 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "domainOwnershipIdentifierName", + "name": "functionName", "in": "path", - "description": "Name of domain ownership identifier.", + "description": "The name of the function.", "required": true, "type": "string" }, { - "name": "domainOwnershipIdentifier", - "in": "body", - "description": "A JSON representation of the domain ownership properties.", + "name": "keyName", + "in": "path", + "description": "The name of the key.", "required": true, - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, + { + "name": "key", + "in": "body", + "description": "The key to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -9879,10 +11039,16 @@ } ], "responses": { + "202": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, "200": { - "description": "OK", + "description": "Key was updated.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -9897,31 +11063,38 @@ "tags": [ "WebApps" ], - "summary": "Deletes a domain ownership identifier for a web app.", - "description": "Deletes a domain ownership identifier for a web app.", - "operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot", + "summary": "Delete a function secret.", + "description": "Delete a function secret.", + "operationId": "WebApps_DeleteFunctionSecretSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { - "name": "name", + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", "in": "path", - "description": "Name of the app.", + "description": "The name of the function.", "required": true, "type": "string" }, { - "name": "domainOwnershipIdentifierName", + "name": "keyName", "in": "path", - "description": "Name of domain ownership identifier.", + "description": "The name of the key.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -9933,21 +11106,23 @@ } ], "responses": { - "200": { - "description": "Successfully deleted domain ownership identifier." + "404": { + "description": "Key was not found." }, "204": { - "description": "Domain ownership identifier does not exist." + "description": "Key was deleted." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", - "description": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", - "operationId": "WebApps_UpdateDomainOwnershipIdentifierSlot", + "summary": "Get function keys for a function in a web site, or a deployment slot.", + "description": "Get function keys for a function in a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctionKeysSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9955,30 +11130,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "domainOwnershipIdentifierName", + "name": "functionName", "in": "path", - "description": "Name of domain ownership identifier.", + "description": "Function name.", "required": true, "type": "string" }, - { - "name": "domainOwnershipIdentifier", - "in": "body", - "description": "A JSON representation of the domain ownership properties.", - "required": true, - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -9991,9 +11157,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function keys returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -10005,14 +11171,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": { + "post": { "tags": [ "WebApps" ], - "summary": "Get the status of the last MSDeploy operation.", - "description": "Get the status of the last MSDeploy operation.", - "operationId": "WebApps_GetMSDeployStatusSlot", + "summary": "Get function secrets for a function in a web site, or a deployment slot.", + "description": "Get function secrets for a function in a web site, or a deployment slot.", + "operationId": "WebApps_ListFunctionSecretsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10020,14 +11186,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -10040,9 +11213,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function secrets returned.", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/FunctionKeys" } }, "default": { @@ -10052,14 +11225,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/status": { + "get": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension.", - "description": "Invoke the MSDeploy web app extension.", - "operationId": "WebApps_CreateMSDeployOperationSlot", + "summary": "Get the status of a function (e.g. errors, etc.)", + "description": "Get the status of a function (e.g. errors, etc.)", + "operationId": "WebApps_GetFunctionStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10067,25 +11242,23 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "slot", + "name": "functionName", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Function name.", "required": true, "type": "string" }, { - "name": "MSDeploy", - "in": "body", - "description": "Details of MSDeploy operation", + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, - "schema": { - "$ref": "#/definitions/MSDeploy" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -10095,27 +11268,26 @@ } ], "responses": { - "201": { - "description": "Deployment is scheduled.", + "200": { + "description": "Function status returned.", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/FunctionStatus" } }, - "409": { - "description": "Another deployment is in progress." + "404": { + "description": "Function with an name of {functionName} does not exist." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Get the MSDeploy Log for the last MSDeploy operation.", - "description": "Get the MSDeploy Log for the last MSDeploy operation.", - "operationId": "WebApps_GetMSDeployLogSlot", + "summary": "Get host secrets for a function app.", + "description": "Get host secrets for a function app.", + "operationId": "WebApps_ListHostKeysSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10123,14 +11295,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -10143,25 +11315,28 @@ ], "responses": { "200": { - "description": "MSDeploy log returned.", + "description": "Host secrets returned.", "schema": { - "$ref": "#/definitions/MSDeployLog" + "$ref": "#/definitions/HostKeys" } }, - "404": { - "description": "MSDeploy log not found." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus": { + "post": { "tags": [ "WebApps" ], - "summary": "List the functions for a web site, or a deployment slot.", - "description": "List the functions for a web site, or a deployment slot.", - "operationId": "WebApps_ListInstanceFunctionsSlot", + "summary": "This is to allow calling via powershell and ARM template.", + "description": "This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10169,14 +11344,14 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", "required": true, "type": "string" }, @@ -10188,29 +11363,20 @@ } ], "responses": { - "200": { - "description": "Function information returned.", - "schema": { - "$ref": "#/definitions/FunctionEnvelopeCollection" - } - }, - "404": { - "description": "Function with an ID of {functionName} is not running." + "204": { + "description": "No Content" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/status": { "get": { "tags": [ "WebApps" ], - "summary": "Fetch a short lived token that can be exchanged for a master key.", - "description": "Fetch a short lived token that can be exchanged for a master key.", - "operationId": "WebApps_GetFunctionsAdminTokenSlot", + "summary": "Gets the current Function host status.", + "description": "Gets the current Function host status.", + "operationId": "WebApps_GetHostStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10218,14 +11384,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -10240,7 +11406,7 @@ "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/HostStatus" } }, "default": { @@ -10252,14 +11418,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync": { + "post": { "tags": [ "WebApps" ], - "summary": "Get function information by its ID for web site, or a deployment slot.", - "description": "Get function information by its ID for web site, or a deployment slot.", - "operationId": "WebApps_GetInstanceFunctionSlot", + "summary": "Syncs function trigger metadata to the management database", + "description": "Syncs function trigger metadata to the management database", + "operationId": "WebApps_SyncFunctionsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10267,21 +11433,14 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "functionName", - "in": "path", - "description": "Function name.", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", "required": true, "type": "string" }, @@ -10293,24 +11452,20 @@ } ], "responses": { - "200": { - "description": "Function information returned.", - "schema": { - "$ref": "#/definitions/FunctionEnvelope" - } - }, - "404": { - "description": "Function with an name of {functionName} is not running." + "204": { + "description": "No Content" } } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}": { "put": { "tags": [ "WebApps" ], - "summary": "Create function for web site, or a deployment slot.", - "description": "Create function for web site, or a deployment slot.", - "operationId": "WebApps_CreateInstanceFunctionSlot", + "summary": "Add or update a host level secret.", + "description": "Add or update a host level secret.", + "operationId": "WebApps_CreateOrUpdateHostSecretSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10323,26 +11478,33 @@ "type": "string" }, { - "name": "functionName", + "name": "keyType", "in": "path", - "description": "Function name.", + "description": "The type of host key.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, { - "name": "function_envelope", + "name": "key", "in": "body", - "description": "Function details.", + "description": "The key to create or update", "required": true, "schema": { - "$ref": "#/definitions/FunctionEnvelope" + "$ref": "#/definitions/KeyInfo" } }, { @@ -10353,10 +11515,16 @@ } ], "responses": { - "201": { - "description": "Function created.", + "202": { + "description": "Key was created.", "schema": { - "$ref": "#/definitions/FunctionEnvelope" + "$ref": "#/definitions/KeyInfo" + } + }, + "200": { + "description": "Key was updated.", + "schema": { + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -10365,16 +11533,15 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-long-running-operation": true + } }, "delete": { "tags": [ "WebApps" ], - "summary": "Delete a function for web site, or a deployment slot.", - "description": "Delete a function for web site, or a deployment slot.", - "operationId": "WebApps_DeleteInstanceFunctionSlot", + "summary": "Delete a host level secret.", + "description": "Delete a host level secret.", + "operationId": "WebApps_DeleteHostSecretSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10384,69 +11551,26 @@ "in": "path", "description": "Site name.", "required": true, - "type": "string" - }, - { - "name": "functionName", - "in": "path", - "description": "Function name.", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Function deleted." - }, - "404": { - "description": "Function does not exist." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": { - "post": { - "tags": [ - "WebApps" - ], - "summary": "Get function secrets for a function in a web site, or a deployment slot.", - "description": "Get function secrets for a function in a web site, or a deployment slot.", - "operationId": "WebApps_ListFunctionSecretsSlot", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" + "type": "string" }, { - "name": "name", + "name": "keyType", "in": "path", - "description": "Site name.", + "description": "The type of host key.", "required": true, "type": "string" }, { - "name": "functionName", + "name": "keyName", "in": "path", - "description": "Function name.", + "description": "The name of the key.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -10458,17 +11582,11 @@ } ], "responses": { - "200": { - "description": "Function secrets returned.", - "schema": { - "$ref": "#/definitions/FunctionSecrets" - } + "404": { + "description": "Key was not found." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Key was deleted." } } } @@ -12103,14 +13221,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listbackups": { "post": { "tags": [ "WebApps" ], - "summary": "This is to allow calling via powershell and ARM template.", - "description": "This is to allow calling via powershell and ARM template.", - "operationId": "WebApps_ListSyncFunctionTriggersSlot", + "summary": "Gets existing backups of an app.", + "description": "Gets existing backups of an app.", + "operationId": "WebApps_ListSiteBackupsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -12125,7 +13243,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.", "required": true, "type": "string" }, @@ -12140,7 +13258,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/FunctionSecrets" + "$ref": "#/definitions/BackupItemCollection" } }, "default": { @@ -12149,6 +13267,49 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "This is to allow calling via powershell and ARM template.", + "description": "This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncFunctionTriggersStatusSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } } } }, @@ -14757,6 +15918,59 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotcopy": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Copies a deployment slot to another deployment slot of an app.", + "description": "Copies a deployment slot to another deployment slot of an app.", + "operationId": "WebApps_CopySlotSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "copySlotEntity", + "in": "body", + "description": "JSON object that contains the target slot name and site config properties to override the source slot config. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmCopySlotEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Operation is in progress." + } + }, + "x-ms-long-running-operation": true + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs": { "post": { "tags": [ @@ -15477,8 +16691,8 @@ "tags": [ "WebApps" ], - "summary": "Syncs function trigger metadata to the scale controller", - "description": "Syncs function trigger metadata to the scale controller", + "summary": "Syncs function trigger metadata to the management database", + "description": "Syncs function trigger metadata to the management database", "operationId": "WebApps_SyncFunctionTriggersSlot", "parameters": [ { @@ -17109,8 +18323,8 @@ "tags": [ "WebApps" ], - "summary": "Syncs function trigger metadata to the scale controller", - "description": "Syncs function trigger metadata to the scale controller", + "summary": "Syncs function trigger metadata to the management database", + "description": "Syncs function trigger metadata to the management database", "operationId": "WebApps_SyncFunctionTriggers", "parameters": [ { @@ -18055,6 +19269,54 @@ } } }, + "AzureStorageInfoValue": { + "description": "Azure Files or Blob Storage access information value for dictionary storage.", + "type": "object", + "properties": { + "type": { + "description": "Type of storage.", + "enum": [ + "AzureFiles", + "AzureBlob" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureStorageType", + "modelAsString": false + } + }, + "accountName": { + "description": "Name of the storage account.", + "type": "string" + }, + "shareName": { + "description": "Name of the file share (container name, for Blob storage).", + "type": "string" + }, + "accessKey": { + "description": "Access key for the storage account.", + "type": "string" + }, + "mountPath": { + "description": "Path to mount the storage within the site's runtime environment.", + "type": "string" + }, + "state": { + "description": "State of the storage account.", + "enum": [ + "Ok", + "InvalidCredentials", + "InvalidShare" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AzureStorageState", + "modelAsString": false + } + } + } + }, "AzureStoragePropertyDictionaryResource": { "description": "AzureStorageInfo dictionary resource.", "type": "object", @@ -18068,7 +19330,7 @@ "description": "Azure storage accounts.", "type": "object", "additionalProperties": { - "$ref": "./CommonDefinitions.json#/definitions/AzureStorageInfoValue" + "$ref": "#/definitions/AzureStorageInfoValue" }, "x-ms-client-flatten": true } @@ -18486,6 +19748,24 @@ } } }, + "CsmCopySlotEntity": { + "description": "Copy deployment slot parameters.", + "required": [ + "targetSlot", + "siteConfig" + ], + "type": "object", + "properties": { + "targetSlot": { + "description": "Destination deployment slot during copy operation.", + "type": "string" + }, + "siteConfig": { + "$ref": "./CommonDefinitions.json#/definitions/SiteConfig", + "description": "The site object which will be merged with the source slot site\nto produce new destination slot site object.\nnull to just copy source slot content. Otherwise a Site\nobject with properties to override source slot site." + } + } + }, "CsmPublishingProfileOptions": { "description": "Publishing options for requested profile.", "type": "object", @@ -18817,7 +20097,7 @@ } }, "FunctionEnvelope": { - "description": "Web Job Information.", + "description": "Function information.", "type": "object", "allOf": [ { @@ -18844,6 +20124,10 @@ "description": "Config URI.", "type": "string" }, + "test_data_href": { + "description": "Test data URI.", + "type": "string" + }, "secrets_file_href": { "description": "Secrets file URI.", "type": "string" @@ -18866,6 +20150,14 @@ "test_data": { "description": "Test data used when testing via the Azure Portal.", "type": "string" + }, + "invoke_url_template": { + "description": "The invocation URL", + "type": "string" + }, + "language": { + "description": "The function language", + "type": "string" } }, "x-ms-client-flatten": true @@ -18893,8 +20185,8 @@ } } }, - "FunctionSecrets": { - "description": "Function secrets.", + "FunctionKeys": { + "description": "Function keys.", "type": "object", "allOf": [ { @@ -18903,7 +20195,7 @@ ], "properties": { "properties": { - "description": "FunctionSecrets resource specific properties", + "description": "FunctionKeys resource specific properties", "properties": { "key": { "description": "Secret key.", @@ -18918,6 +20210,65 @@ } } }, + "FunctionStatus": { + "description": "Function status.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "FunctionStatus resource specific properties", + "properties": { + "errors": { + "description": "Collection of initialization errors for the function.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "HostKeys": { + "description": "Functions host level keys.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HostKeys resource specific properties", + "properties": { + "masterKey": { + "description": "Secret key.", + "type": "string" + }, + "functionKeys": { + "description": "Host level function keys.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "systemKeys": { + "description": "System keys.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + } + } + }, "HostNameBinding": { "description": "A hostname binding object.", "type": "object", @@ -19058,6 +20409,39 @@ } } }, + "HostStatus": { + "description": "Function host status.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HostStatus resource specific properties", + "properties": { + "id": { + "description": "The host id.", + "type": "string" + }, + "state": { + "description": "The current host state.", + "type": "string" + }, + "version": { + "description": "The Function runtime version.", + "type": "string" + }, + "versionDetails": { + "description": "The Function runtime version details.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, "HttpLogsConfig": { "description": "Http logs configuration.", "type": "object", @@ -19072,6 +20456,31 @@ } } }, + "KeyInfo": { + "description": "Function key info.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "KeyInfo resource specific properties", + "properties": { + "name": { + "description": "Key name", + "type": "string" + }, + "value": { + "description": "Key value", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, "MSDeploy": { "description": "MSDeploy ARM PUT information", "type": "object", @@ -20918,13 +22327,6 @@ "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" - }, - "geoDistributions": { - "description": "GeoDistributions for this site", - "type": "array", - "items": { - "$ref": "./CommonDefinitions.json#/definitions/GeoDistribution" - } } }, "x-ms-client-flatten": true @@ -21683,4 +23085,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-11-01/Certificates.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-11-01/Certificates.json index bbabb17bffce..88c3439c83e2 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-11-01/Certificates.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-11-01/Certificates.json @@ -354,7 +354,7 @@ }, "expirationDate": { "format": "date-time", - "description": "Certificate expiration date.", + "description": "Certificate expriration date.", "type": "string", "readOnly": true }, @@ -511,7 +511,7 @@ }, "expirationDate": { "format": "date-time", - "description": "Certificate expiration date.", + "description": "Certificate expriration date.", "type": "string", "readOnly": true }, diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-11-01/Provider.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-11-01/Provider.json new file mode 100644 index 000000000000..926e7f29c787 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-11-01/Provider.json @@ -0,0 +1,301 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-11-01", + "title": "Provider API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Web/availableStacks": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Get available application frameworks and their versions", + "description": "Get available application frameworks and their versions", + "operationId": "Provider_GetAvailableStacks", + "parameters": [ + { + "name": "osTypeSelected", + "in": "query", + "type": "string", + "enum": [ + "Windows", + "Linux", + "WindowsFunctions", + "LinuxFunctions" + ] + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationStackCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Web/operations": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions", + "description": "Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions", + "operationId": "Provider_ListOperations", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/CsmOperationCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/availableStacks": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Get available application frameworks and their versions", + "description": "Get available application frameworks and their versions", + "operationId": "Provider_GetAvailableStacksOnPrem", + "parameters": [ + { + "name": "osTypeSelected", + "in": "query", + "type": "string", + "enum": [ + "Windows", + "Linux", + "WindowsFunctions", + "LinuxFunctions" + ] + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationStackCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApplicationStack": { + "description": "Application stack.", + "type": "object", + "properties": { + "name": { + "description": "Application stack name.", + "type": "string" + }, + "display": { + "description": "Application stack display name.", + "type": "string" + }, + "dependency": { + "description": "Application stack dependency.", + "type": "string" + }, + "majorVersions": { + "description": "List of major versions available.", + "type": "array", + "items": { + "$ref": "#/definitions/StackMajorVersion" + } + }, + "frameworks": { + "description": "List of frameworks associated with application stack.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationStack" + } + } + } + }, + "ApplicationStackCollection": { + "description": "Collection of Application Stacks", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationStackResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ApplicationStackResource": { + "description": "ARM resource for a ApplicationStack.", + "type": "object", + "allOf": [ + { + "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationStack", + "description": "Core resource properties", + "x-ms-client-flatten": true + } + } + }, + "StackMajorVersion": { + "description": "Application stack major version.", + "type": "object", + "properties": { + "displayVersion": { + "description": "Application stack major version (display only).", + "type": "string" + }, + "runtimeVersion": { + "description": "Application stack major version (runtime only).", + "type": "string" + }, + "isDefault": { + "description": "true if this is the default major version; otherwise, false.", + "type": "boolean" + }, + "minorVersions": { + "description": "Minor versions associated with the major version.", + "type": "array", + "items": { + "$ref": "#/definitions/StackMinorVersion" + } + }, + "applicationInsights": { + "description": "true if this supports Application Insights; otherwise, false.", + "type": "boolean" + } + } + }, + "StackMinorVersion": { + "description": "Application stack minor version.", + "type": "object", + "properties": { + "displayVersion": { + "description": "Application stack minor version (display only).", + "type": "string" + }, + "runtimeVersion": { + "description": "Application stack minor version (runtime only).", + "type": "string" + }, + "isDefault": { + "description": "true if this is the default minor version; otherwise, false.", + "type": "boolean" + }, + "isRemoteDebuggingEnabled": { + "description": "true if this supports Remote Debugging, otherwise false.", + "type": "boolean" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index 5e5c9e787795..62768f66d96a 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -49,10 +49,11 @@ input-file: - Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json - Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json - Microsoft.Web/stable/2018-11-01/Certificates.json +- Microsoft.Web/stable/2018-02-01/ClassicMobileServices.json - Microsoft.Web/stable/2018-02-01/CommonDefinitions.json - Microsoft.Web/stable/2018-02-01/DeletedWebApps.json - Microsoft.Web/stable/2018-02-01/Diagnostics.json -- Microsoft.Web/stable/2018-02-01/Provider.json +- Microsoft.Web/stable/2018-11-01/Provider.json - Microsoft.Web/stable/2018-02-01/Recommendations.json - Microsoft.Web/stable/2018-02-01/ResourceProvider.json - Microsoft.Web/stable/2018-02-01/WebApps.json