From 3da06e8eff0600971b6c176b40084507099f1ec6 Mon Sep 17 00:00:00 2001 From: Mathew Charles Date: Tue, 10 Sep 2019 13:55:58 -0700 Subject: [PATCH 1/4] Updating Functions ARM API specs --- custom-words.txt | 1 + .../stable/2018-02-01/WebApps.json | 6213 ++++++++++------- 2 files changed, 3846 insertions(+), 2368 deletions(-) diff --git a/custom-words.txt b/custom-words.txt index 19383a9ce803..f1acd36fc676 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -702,6 +702,7 @@ listsas listsecrets LISTSTATUS listsyncfunctiontriggerstatus +listsyncstatus liveevent liveoutput loadbalancer 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 f9b436eef1bc..9b6640f2c7df 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 a 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": { + "201": { + "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/FunctionSecrets" } }, "default": { @@ -3299,14 +3317,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/properties/state": { + "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 enablement state for a function.", + "description": "Get the enablement state for a function.", + "operationId": "WebApps_GetFunctionState", "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,23 @@ ], "responses": { "200": { - "description": "Successfully deleted hostname binding." + "description": "Function state returned.", + "schema": { + "type": "string" + } }, - "204": { - "description": "Hostname binding does not exist." + "404": { + "description": "Function with a name of {functionName} does not exist." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { - "get": { + }, + "put": { "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": "Set the enablement state for a function.", + "description": "Set the enablement state for a function.", + "operationId": "WebApps_UpdateFunctionState", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3357,23 +3378,24 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "namespaceName", + "name": "functionName", "in": "path", - "description": "The namespace for this hybrid connection.", + "description": "Function name.", "required": true, "type": "string" }, { - "name": "relayName", - "in": "path", - "description": "The relay name for this hybrid connection.", + "name": "requestEnvelope", + "in": "body", "required": true, - "type": "string" + "schema": { + "type": "string" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -3384,26 +3406,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "The function state was updated.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "type": "string" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Function with a name of {functionName} does not exist." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/properties/status": { + "get": { "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": "Get function status.", + "description": "Get function status.", + "operationId": "WebApps_GetFunctionStatus", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3411,33 +3432,56 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "namespaceName", + "name": "functionName", "in": "path", - "description": "The namespace for this hybrid connection.", + "description": "Function name.", "required": true, "type": "string" }, { - "name": "relayName", - "in": "path", - "description": "The relay name for this hybrid connection.", - "required": true, - "type": "string" + "$ref": "#/parameters/subscriptionIdParameter" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "The details of the hybrid connection.", - "required": true, + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function status returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/FunctionStatus" } }, + "404": { + "description": "Function with a name of {functionName} does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get host secrets for a function app.", + "description": "Get host secrets for a function app.", + "operationId": "WebApps_ListHostKeys", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3447,9 +3491,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Host secrets returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/HostKeys" } }, "default": { @@ -3459,14 +3503,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus": { + "post": { "tags": [ "WebApps" ], - "summary": "Removes a Hybrid Connection from this site.", - "description": "Removes a Hybrid Connection from this site.", - "operationId": "WebApps_DeleteHybridConnection", + "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" @@ -3474,21 +3520,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 +3532,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/properties/config": { + "get": { "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": "Get the host configuration (host.json).", + "description": "Get the host configuration (host.json).", + "operationId": "WebApps_GetHostConfig", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3522,32 +3553,51 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Site name.", "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": { + "200": { + "description": "Host configuration returned.", + "schema": { + "type": "object" + } }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The details of the hybrid connection.", - "required": true, + "default": { + "description": "App Service error response.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/properties/status": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get the host status.", + "description": "Get the host status.", + "operationId": "WebApps_GetHostStatus", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -3558,9 +3608,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Host status returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/HostStatus" } }, "default": { @@ -3572,14 +3622,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync": { "post": { "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": "Syncs function trigger metadata to the management database", + "description": "Syncs function trigger metadata to the management database", + "operationId": "WebApps_SyncFunctions", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3587,24 +3637,66 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "namespaceName", + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Add or update a host level secret.", + "description": "Add or update a host level secret.", + "operationId": "WebApps_CreateOrUpdateHostSecret", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", "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" + }, + { + "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" }, @@ -3613,10 +3705,16 @@ } ], "responses": { + "201": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, "200": { - "description": "OK", + "description": "Key was updated.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnectionKey" + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -3626,16 +3724,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": { - "get": { + }, + "delete": { "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", + "summary": "Delete a host level secret.", + "description": "Delete a host level secret.", + "operationId": "WebApps_DeleteHostSecret", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3643,7 +3739,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "keyType", + "in": "path", + "description": "The type of host key.", + "required": true, + "type": "string" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the key.", "required": true, "type": "string" }, @@ -3655,29 +3765,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 +3804,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/HostNameBindingCollection" } }, "default": { @@ -3709,17 +3813,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 +3839,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 +3856,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/HostNameBinding" } }, "default": { @@ -3764,9 +3871,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 +3886,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 +3912,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/HostNameBinding" } }, "default": { @@ -3820,9 +3927,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 +3942,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 +3957,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 +3980,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 +4009,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { @@ -3912,16 +4019,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,23 +4034,46 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebAppInstanceCollection" - } + "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" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + } }, "default": { "description": "App Service error response.", @@ -3953,20 +4081,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 +4097,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 +4124,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 +4145,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", + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", "in": "body", - "description": "Details of MSDeploy operation", + "description": "The details of the hybrid connection.", "required": true, "schema": { - "$ref": "#/definitions/MSDeploy" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, { @@ -4049,27 +4180,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 +4210,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 +4237,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 +4266,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 +4279,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 +4308,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 +4321,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 +4350,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,47 +4369,53 @@ } ], "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", - "parameters": [ - { + "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" }, { "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 +4428,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 +4453,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 +4473,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 +4494,25 @@ { "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": "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 +4523,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 +4552,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 +4565,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 +4582,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 +4597,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 +4617,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 +4644,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 +4672,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 +4700,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 +4720,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 +4746,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 +4766,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 +4780,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 +4795,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 +4822,47 @@ ], "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.", - "operationId": "WebApps_MigrateStorage", + "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": [ - { - "name": "subscriptionName", - "in": "query", - "description": "Azure subscription.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "migrationOptions", - "in": "body", - "description": "Migration migrationOptions.", + "name": "processId", + "in": "path", + "description": "PID.", "required": true, - "schema": { - "$ref": "#/definitions/StorageMigrationOptions" - } + "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" @@ -4773,30 +4872,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StorageMigrationResponse" - } + "204": { + "description": "Process terminated." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": { + "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": "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" @@ -4804,18 +4896,23 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "migrationRequestEnvelope", - "in": "body", - "description": "MySql migration options.", + "name": "processId", + "in": "path", + "description": "PID.", "required": true, - "schema": { - "$ref": "#/definitions/MigrateMySqlRequest" - } + "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" @@ -4828,27 +4925,23 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "file" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": { "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": "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" @@ -4856,7 +4949,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "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" }, @@ -4869,28 +4976,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "#/definitions/MigrateMySqlStatus" + "$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": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a Swift Virtual Network connection.", - "description": "Gets a Swift Virtual Network connection.", - "operationId": "WebApps_GetSwiftVirtualNetworkConnection", + "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" @@ -4898,7 +5005,28 @@ { "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" + }, + { + "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" }, @@ -4911,26 +5039,25 @@ ], "responses": { "200": { - "description": "OK.", + "description": "Module information returned.", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$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." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": { + "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": "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" @@ -4938,18 +5065,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "Properties of the Virtual Network connection. See example.", + "name": "processId", + "in": "path", + "description": "PID.", "required": true, - "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" - } + "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" @@ -4960,26 +5092,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$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" } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads/{threadId}": { + "get": { "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": "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" @@ -4987,7 +5121,28 @@ { "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" + }, + { + "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" }, @@ -5000,20 +5155,25 @@ ], "responses": { "200": { - "description": "Successfully deleted virtual network." + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfo" + } }, "404": { - "description": "Virtual network does not exist." + "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { + "post": { "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", + "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" @@ -5025,15 +5185,6 @@ "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" }, @@ -5043,9 +5194,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "#/definitions/SiteCloneability" } }, "default": { @@ -5057,14 +5208,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": { + "post": { "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": "This is to allow calling via powershell and ARM template.", + "description": "This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncFunctionTriggers", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5076,13 +5227,6 @@ "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" }, @@ -5092,25 +5236,28 @@ ], "responses": { "200": { - "description": "OK.", + "description": "OK", "schema": { - "$ref": "#/definitions/NetworkFeatures" + "$ref": "#/definitions/FunctionSecrets" } }, - "404": { - "description": "The requested view does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { "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", + "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" @@ -5122,13 +5269,6 @@ "required": true, "type": "string" }, - { - "name": "operationId", - "in": "path", - "description": "GUID of the operation.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5140,19 +5280,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": "./CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection" } }, "default": { @@ -5162,21 +5290,19 @@ } } }, - "x-ms-examples": { - "Get the current status of a network trace operation for a site": { - "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" - } + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "get": { "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", + "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" @@ -5184,29 +5310,22 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "durationInSeconds", - "in": "query", - "description": "The duration to keep capturing in seconds.", - "type": "integer", - "format": "int32" - }, - { - "name": "maxFrameLength", + "name": "details", "in": "query", - "description": "The maximum frame length in bytes (Optional).", - "type": "integer", - "format": "int32" + "description": "Specify \"true\" to include metric details in the response. It is \"false\" by default.", + "type": "boolean" }, { - "name": "sasUrl", + "name": "$filter", "in": "query", - "description": "The Blob URL to store capture file.", - "type": "string" + "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" @@ -5219,7 +5338,7 @@ "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricCollection" } }, "default": { @@ -5228,47 +5347,46 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": { + "put": { "tags": [ "WebApps" ], - "summary": "Start capturing network packets for the site.", - "description": "Start capturing network packets for the site.", - "operationId": "WebApps_StartWebSiteNetworkTraceOperation", + "summary": "Restores a web app.", + "description": "Restores a web app.", + "operationId": "WebApps_MigrateStorage", "parameters": [ + { + "name": "subscriptionName", + "in": "query", + "description": "Azure subscription.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of 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" + "name": "migrationOptions", + "in": "body", + "description": "Migration migrationOptions.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageMigrationOptions" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -5281,19 +5399,1164 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$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 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" + } + } + }, + "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" + }, + { + "$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" - } + "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}/networkTraces/{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_GetNetworkTracesV2", + "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" + } + } + }, + "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" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PerfMonCounterCollection" + } + }, + "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}/phplogging": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets web app's event logs.", + "description": "Gets web app's event logs.", + "operationId": "WebApps_GetSitePhpErrorLogFlag", + "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/SitePhpErrorLogFlag" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { + "get": { + "tags": [ + "WebApps" + ], + "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" + }, + { + "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/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { + "get": { + "tags": [ + "WebApps" + ], + "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" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "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" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "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" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "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" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted premier add-on." + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "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" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "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/PremierAddOnPatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { + "get": { + "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", + "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": "OK", + "schema": { + "$ref": "#/definitions/PrivateAccess" } }, "default": { @@ -5302,23 +6565,108 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-examples": { - "Start a new network trace operation for a site": { - "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" + } + }, + "put": { + "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", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "access", + "in": "body", + "description": "The information for the private access", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateAccess" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { + "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_ListProcesses", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Process terminated.", + "schema": { + "$ref": "#/definitions/ProcessInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running." } }, - "x-ms-long-running-operation": true + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Stop ongoing capturing network packets for the site.", - "description": "Stop ongoing capturing network packets for the site.", - "operationId": "WebApps_StopWebSiteNetworkTrace", + "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" @@ -5326,7 +6674,14 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", "required": true, "type": "string" }, @@ -5339,27 +6694,112 @@ ], "responses": { "200": { - "description": "Stopped." + "description": "Process information returned.", + "schema": { + "$ref": "#/definitions/ProcessInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running." + } + } + }, + "delete": { + "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", + "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" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { "204": { - "description": "Stopped." + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running." } - }, - "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}/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_GetProcessDump", + "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" + }, + { + "$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}/networkTrace/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": { "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": "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" @@ -5367,14 +6807,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" }, @@ -5387,36 +6827,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$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-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}/modules/{baseAddress}": { "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_GetProcessModule", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5424,14 +6856,21 @@ { "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" + }, + { + "name": "baseAddress", + "in": "path", + "description": "Module base address.", "required": true, "type": "string" }, @@ -5444,45 +6883,25 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } - }, - "202": { - "description": "Operation is in progress.", + "description": "Module information returned.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$ref": "#/definitions/ProcessModuleInfo" } }, - "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, or a module with the specified baseAddress was not found." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": { "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_GetNetworkTracesV2", + "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" @@ -5490,14 +6909,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" }, @@ -5510,36 +6929,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$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-examples": { - "Get NetworkTraces for a site": { - "$ref": "./examples/GetWebSiteNetworkTraces.json" - } + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId}": { + "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 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" @@ -5547,7 +6958,21 @@ { "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" + }, + { + "name": "threadId", + "in": "path", + "description": "TID.", "required": true, "type": "string" }, @@ -5560,22 +6985,25 @@ ], "responses": { "200": { - "description": "Successfully generate new password." + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfo" + } }, - "204": { - "description": "Successfully generate new password." + "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}/perfcounters": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { "get": { "tags": [ "WebApps" ], - "summary": "Gets perfmon counters for web app.", - "description": "Gets perfmon counters for web app.", - "operationId": "WebApps_ListPerfMonCounters", + "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" @@ -5583,17 +7011,10 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the 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" }, @@ -5605,7 +7026,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PerfMonCounterCollection" + "$ref": "#/definitions/PublicCertificateCollection" } }, "default": { @@ -5620,14 +7041,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets web app's event logs.", - "description": "Gets web app's event logs.", - "operationId": "WebApps_GetSitePhpErrorLogFlag", + "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" @@ -5635,7 +7056,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", "required": true, "type": "string" }, @@ -5650,7 +7078,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SitePhpErrorLogFlag" + "$ref": "#/definitions/PublicCertificate" } }, "default": { @@ -5660,16 +7088,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets the premier add-ons of an app.", - "description": "Gets the premier add-ons of an app.", - "operationId": "WebApps_ListPremierAddOns", + "summary": "Creates a hostname binding for an app.", + "description": "Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdatePublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5681,6 +7107,22 @@ "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" }, @@ -5692,7 +7134,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/PublicCertificate" } }, "default": { @@ -5702,16 +7144,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets a named add-on of an app.", - "description": "Gets a named add-on of an app.", - "operationId": "WebApps_GetPremierAddOn", + "summary": "Deletes a hostname binding for an app.", + "description": "Deletes a hostname binding for an app.", + "operationId": "WebApps_DeletePublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5724,9 +7164,9 @@ "type": "string" }, { - "name": "premierAddOnName", + "name": "publicCertificateName", "in": "path", - "description": "Add-on name.", + "description": "Public certificate name.", "required": true, "type": "string" }, @@ -5739,26 +7179,25 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PremierAddOn" - } + "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": "Updates a named add-on of an app.", - "description": "Updates a named add-on of an app.", - "operationId": "WebApps_AddPremierAddOn", + "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" @@ -5771,19 +7210,12 @@ "type": "string" }, { - "name": "premierAddOnName", - "in": "path", - "description": "Add-on name.", - "required": true, - "type": "string" - }, - { - "name": "premierAddOn", + "name": "publishingProfileOptions", "in": "body", - "description": "A JSON representation of the edited premier add-on.", + "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", "required": true, "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/CsmPublishingProfileOptions" } }, { @@ -5797,7 +7229,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "type": "file" } }, "default": { @@ -5807,14 +7239,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { + "post": { "tags": [ "WebApps" ], - "summary": "Delete a premier add-on from an app.", - "description": "Delete a premier add-on from an app.", - "operationId": "WebApps_DeletePremierAddOn", + "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" @@ -5826,13 +7260,6 @@ "required": true, "type": "string" }, - { - "name": "premierAddOnName", - "in": "path", - "description": "Add-on name.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5842,17 +7269,19 @@ ], "responses": { "200": { - "description": "Successfully deleted premier add-on." + "description": "OK." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates a named add-on of an app.", - "description": "Updates a named add-on of an app.", - "operationId": "WebApps_UpdatePremierAddOn", + "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" @@ -5865,20 +7294,16 @@ "type": "string" }, { - "name": "premierAddOnName", - "in": "path", - "description": "Add-on name.", - "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": "premierAddOn", - "in": "body", - "description": "A JSON representation of the edited premier add-on.", - "required": true, - "schema": { - "$ref": "#/definitions/PremierAddOnPatchResource" - } + "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" @@ -5889,28 +7314,19 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PremierAddOn" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "description": "Successfully restarted app." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": { + "post": { "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": "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" @@ -5918,10 +7334,19 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, + { + "name": "request", + "in": "body", + "description": "Information on restore request .", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5930,27 +7355,24 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PrivateAccess" - } + "202": { + "description": "Restore operation started." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "200": { + "description": "Restore operation started." } - } - }, - "put": { + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { + "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": "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" @@ -5958,17 +7380,17 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "access", + "name": "restoreRequest", "in": "body", - "description": "The information for the private access", + "description": "Deleted web app restore information.", "required": true, "schema": { - "$ref": "#/definitions/PrivateAccess" + "$ref": "#/definitions/DeletedAppRestoreRequest" } }, { @@ -5979,29 +7401,24 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PrivateAccess" - } + "202": { + "description": "Restore operation started." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "200": { + "description": "Restore operation started." } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": { + "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": "Restores a web app from a snapshot.", + "description": "Restores a web app from a snapshot.", + "operationId": "WebApps_RestoreSnapshot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6009,10 +7426,19 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of web app.", "required": true, "type": "string" }, + { + "name": "restoreRequest", + "in": "body", + "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotRestoreRequest" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6021,29 +7447,24 @@ } ], "responses": { - "200": { - "description": "Process terminated.", - "schema": { - "$ref": "#/definitions/ProcessInfoCollection" - } + "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}": { + "/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_GetProcess", + "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" @@ -6055,13 +7476,6 @@ "required": true, "type": "string" }, - { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6071,23 +7485,28 @@ ], "responses": { "200": { - "description": "Process information returned.", + "description": "SiteExtension information returned.", "schema": { - "$ref": "#/definitions/ProcessInfo" + "$ref": "#/definitions/SiteExtensionInfoCollection" } }, "404": { - "description": "Process with the specified ID is not running." + "description": "SiteExtension not found." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": { + "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_DeleteProcess", + "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" @@ -6100,9 +7519,9 @@ "type": "string" }, { - "name": "processId", + "name": "siteExtensionId", "in": "path", - "description": "PID.", + "description": "Site extension name.", "required": true, "type": "string" }, @@ -6114,23 +7533,24 @@ } ], "responses": { - "204": { - "description": "Process terminated." + "200": { + "description": "SiteExtension information returned.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } }, "404": { - "description": "Process with the specified ID is not running." + "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/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_GetProcessDump", + ], + "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" @@ -6143,9 +7563,9 @@ "type": "string" }, { - "name": "processId", + "name": "siteExtensionId", "in": "path", - "description": "PID.", + "description": "Site extension name.", "required": true, "type": "string" }, @@ -6157,26 +7577,31 @@ } ], "responses": { + "201": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, "200": { - "description": "OK", + "description": "Site Extension created.", "schema": { - "type": "file" + "$ref": "#/definitions/SiteExtensionInfo" } }, - "404": { - "description": "Process with the specified ID 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}/processes/{processId}/modules": { - "get": { + }, + "x-ms-long-running-operation": true + }, + "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_ListProcessModules", + "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" @@ -6189,9 +7614,9 @@ "type": "string" }, { - "name": "processId", + "name": "siteExtensionId", "in": "path", - "description": "PID.", + "description": "Site extension name.", "required": true, "type": "string" }, @@ -6203,29 +7628,23 @@ } ], "responses": { - "200": { - "description": "Module information returned.", - "schema": { - "$ref": "#/definitions/ProcessModuleInfoCollection" - } + "204": { + "description": "SiteExtension terminated." }, "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}/modules/{baseAddress}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { "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": "Gets an app's deployment slots.", + "description": "Gets an app's deployment slots.", + "operationId": "WebApps_ListSlots", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6233,21 +7652,7 @@ { "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.", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -6260,25 +7665,31 @@ ], "responses": { "200": { - "description": "Module information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessModuleInfo" + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" } }, - "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" + } } + }, + "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}/slots/{slot}": { "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": "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" @@ -6286,14 +7697,14 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", + "name": "slot", "in": "path", - "description": "PID.", + "description": "Name of the deployment slot. By default, this API returns the production slot.", "required": true, "type": "string" }, @@ -6306,28 +7717,23 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "OK.", "schema": { - "$ref": "#/definitions/ProcessThreadInfoCollection" + "$ref": "./CommonDefinitions.json#/definitions/Site" } }, "404": { - "description": "Process with the specified ID is not running." + "description": "Not found." } - }, - "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": "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" @@ -6335,21 +7741,23 @@ { "name": "name", "in": "path", - "description": "Site name.", + "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": "processId", - "in": "path", - "description": "PID.", + "name": "siteEnvelope", + "in": "body", + "description": "A JSON representation of the app properties. See example.", "required": true, - "type": "string" + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } }, { - "name": "threadId", + "name": "slot", "in": "path", - "description": "TID.", + "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" }, @@ -6362,25 +7770,33 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "OK.", "schema": { - "$ref": "#/definitions/ProcessThreadInfo" + "$ref": "./CommonDefinitions.json#/definitions/Site" } }, - "404": { - "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - } - } - }, - "/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": "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" @@ -6388,10 +7804,29 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of the app to delete.", "required": true, "type": "string" }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to delete. By default, the API deletes 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" }, @@ -6401,31 +7836,23 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PublicCertificateCollection" - } + "description": "Successfully deleted web app." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Successfully deleted web app." + }, + "404": { + "description": "Web app not found." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { - "get": { + }, + "patch": { "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": "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" @@ -6433,14 +7860,23 @@ { "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": "publicCertificateName", + "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": "Public certificate name.", + "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" }, @@ -6453,9 +7889,15 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { - "$ref": "#/definitions/PublicCertificate" + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" } }, "default": { @@ -6465,14 +7907,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { + "get": { "tags": [ "WebApps" ], - "summary": "Creates a hostname binding for an app.", - "description": "Creates a hostname binding for an app.", - "operationId": "WebApps_CreateOrUpdatePublicCertificate", + "summary": "Analyze a custom hostname.", + "description": "Analyze a custom hostname.", + "operationId": "WebApps_AnalyzeCustomHostnameSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6480,25 +7924,22 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "publicCertificateName", + "name": "slot", "in": "path", - "description": "Public certificate name.", + "description": "Name of web app slot. If not specified then will default to production slot.", "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" - } + "name": "hostName", + "in": "query", + "description": "Custom hostname.", + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6511,7 +7952,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PublicCertificate" + "$ref": "#/definitions/CustomHostnameAnalysisResult" } }, "default": { @@ -6521,14 +7962,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "post": { "tags": [ "WebApps" ], - "summary": "Deletes a hostname binding for an app.", - "description": "Deletes a hostname binding for an app.", - "operationId": "WebApps_DeletePublicCertificate", + "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" @@ -6541,9 +7984,18 @@ "type": "string" }, { - "name": "publicCertificateName", + "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": "Public certificate name.", + "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" }, @@ -6556,25 +8008,19 @@ ], "responses": { "200": { - "description": "Successfully deleted hostname binding." - }, - "204": { - "description": "Hostname binding does not exist." + "description": "OK." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { "post": { "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 backup of an app.", + "description": "Creates a backup of an app.", + "operationId": "WebApps_BackupSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6587,14 +8033,21 @@ "type": "string" }, { - "name": "publishingProfileOptions", + "name": "request", "in": "body", - "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", + "description": "Backup configuration. You can use the JSON response from the POST action as input here.", "required": true, "schema": { - "$ref": "#/definitions/CsmPublishingProfileOptions" + "$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" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6606,7 +8059,7 @@ "200": { "description": "OK", "schema": { - "type": "file" + "$ref": "#/definitions/BackupItem" } }, "default": { @@ -6618,14 +8071,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { + "get": { "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": "Gets existing backups of an app.", + "description": "Gets existing backups of an app.", + "operationId": "WebApps_ListBackupsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6637,6 +8090,13 @@ "required": true, "type": "string" }, + { + "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.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6646,19 +8106,31 @@ ], "responses": { "200": { - "description": "OK." + "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}/restart": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Restarts an app (or deployment slot, if specified).", - "description": "Restarts an app (or deployment slot, if specified).", - "operationId": "WebApps_Restart", + "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" @@ -6671,16 +8143,18 @@ "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": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" }, { - "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" + "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" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6691,19 +8165,26 @@ ], "responses": { "200": { - "description": "Successfully restarted app." + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": { - "post": { + }, + "delete": { "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": "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" @@ -6716,13 +8197,18 @@ "type": "string" }, { - "name": "request", - "in": "body", - "description": "Information on restore request .", + "name": "backupId", + "in": "path", + "description": "ID of the backup.", "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 delete a backup of the production slot.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6732,24 +8218,23 @@ } ], "responses": { - "202": { - "description": "Restore operation started." - }, "200": { - "description": "Restore operation started." + "description": "Successfully deleted web app backup item." + }, + "404": { + "description": "Web app backup item does not exist." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { "post": { "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": "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" @@ -6762,14 +8247,28 @@ "type": "string" }, { - "name": "restoreRequest", + "name": "backupId", + "in": "path", + "description": "ID of backup.", + "required": true, + "type": "string" + }, + { + "name": "request", "in": "body", - "description": "Deleted web app restore information.", + "description": "Information on backup request.", "required": true, "schema": { - "$ref": "#/definitions/DeletedAppRestoreRequest" + "$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" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6778,24 +8277,29 @@ } ], "responses": { - "202": { - "description": "Restore operation started." - }, "200": { - "description": "Restore operation started." + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + }, + "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}/backups/{backupId}/restore": { "post": { "tags": [ "WebApps" ], - "summary": "Restores a web app from a snapshot.", - "description": "Restores a web app from a snapshot.", - "operationId": "WebApps_RestoreSnapshot", + "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" @@ -6803,19 +8307,33 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "restoreRequest", + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "request", "in": "body", - "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "description": "Information on restore request .", "required": true, "schema": { - "$ref": "#/definitions/SnapshotRestoreRequest" + "$ref": "#/definitions/RestoreRequest" } }, + { + "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" }, @@ -6834,14 +8352,14 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": { "get": { "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": "List the configurations of an app", + "description": "List the configurations of an app", + "operationId": "WebApps_ListConfigurationsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6849,7 +8367,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 will return configuration for the production slot.", "required": true, "type": "string" }, @@ -6862,13 +8387,16 @@ ], "responses": { "200": { - "description": "SiteExtension information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/SiteExtensionInfoCollection" + "$ref": "#/definitions/SiteConfigResourceCollection" } }, - "404": { - "description": "SiteExtension not found." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } }, "x-ms-pageable": { @@ -6876,14 +8404,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { + "put": { "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": "Replaces the application settings of an app.", + "description": "Replaces the application settings of an app.", + "operationId": "WebApps_UpdateApplicationSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6891,14 +8419,23 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteExtensionId", + "name": "appSettings", + "in": "body", + "description": "Application settings of the app.", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, + { + "name": "slot", "in": "path", - "description": "Site extension name.", + "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" }, @@ -6911,23 +8448,28 @@ ], "responses": { "200": { - "description": "SiteExtension information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/SiteExtensionInfo" + "$ref": "#/definitions/StringDictionary" } }, - "404": { - "description": "SiteExtension with an ID of {siteExtensionId} is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { + "post": { "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 the application settings of an app.", + "description": "Gets the application settings of an app.", + "operationId": "WebApps_ListApplicationSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6935,14 +8477,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 the application settings for the production slot.", "required": true, "type": "string" }, @@ -6954,31 +8496,29 @@ } ], "responses": { - "201": { - "description": "Site Extension created.", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/SiteExtensionInfo" + "$ref": "#/definitions/StringDictionary" } }, - "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": { + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { + "put": { "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": "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" @@ -6986,50 +8526,23 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "siteExtensionId", - "in": "path", - "description": "Site extension name.", + "name": "siteAuthSettings", + "in": "body", + "description": "Auth settings associated with web app.", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "204": { - "description": "SiteExtension terminated." - }, - "404": { - "description": "SiteExtension with an ID of {siteExtensionId} is not running." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Gets an app's deployment slots.", - "description": "Gets an app's deployment slots.", - "operationId": "WebApps_ListSlots", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } }, { - "name": "name", + "name": "slot", "in": "path", - "description": "Name of the app.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -7044,7 +8557,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + "$ref": "#/definitions/SiteAuthSettings" } }, "default": { @@ -7053,20 +8566,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}/config/authsettings/list": { + "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": "Gets the Authentication/Authorization settings of an app.", + "description": "Gets the Authentication/Authorization settings of an app.", + "operationId": "WebApps_GetAuthSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7081,7 +8591,7 @@ { "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 get the settings for the production slot.", "required": true, "type": "string" }, @@ -7094,23 +8604,28 @@ ], "responses": { "200": { - "description": "OK.", + "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" + "$ref": "#/definitions/SiteAuthSettings" } }, - "404": { - "description": "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}/config/azurestorageaccounts": { "put": { "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": "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" @@ -7118,23 +8633,23 @@ { "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", + "name": "azureStorageAccounts", "in": "body", - "description": "A JSON representation of the app properties. See example.", + "description": "Azure storage accounts of the app.", "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, { "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 update the Azure storage account configurations for the production slot.", "required": true, "type": "string" }, @@ -7147,15 +8662,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/AzureStoragePropertyDictionaryResource" } }, "default": { @@ -7164,16 +8673,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-long-running-operation": true - }, - "delete": { + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": { + "post": { "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": "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" @@ -7181,29 +8691,17 @@ { "name": "name", "in": "path", - "description": "Name of the app to delete.", + "description": "Name of the app.", "required": true, "type": "string" }, { "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 Azure storage account configurations 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 +8711,28 @@ ], "responses": { "200": { - "description": "Successfully deleted web app." - }, - "204": { - "description": "Successfully deleted web app." + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + } }, - "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/backup": { + "put": { "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": "Updates the backup configuration of an app.", + "description": "Updates the backup configuration of an app.", + "operationId": "WebApps_UpdateBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7237,23 +8740,23 @@ { "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", + "name": "request", "in": "body", - "description": "A JSON representation of the app properties. See example.", + "description": "Edited backup configuration.", "required": true, "schema": { - "$ref": "#/definitions/SitePatchResource" + "$ref": "#/definitions/BackupRequest" } }, { "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 update the backup configuration for the production slot.", "required": true, "type": "string" }, @@ -7266,15 +8769,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/BackupRequest" } }, "default": { @@ -7284,16 +8781,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Analyze a custom hostname.", - "description": "Analyze a custom hostname.", - "operationId": "WebApps_AnalyzeCustomHostnameSlot", + "summary": "Deletes the backup configuration of an app.", + "description": "Deletes the backup configuration of an app.", + "operationId": "WebApps_DeleteBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7301,23 +8796,17 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "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 will delete the backup configuration for the production slot.", "required": true, "type": "string" }, - { - "name": "hostName", - "in": "query", - "description": "Custom hostname.", - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7327,28 +8816,19 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CustomHostnameAnalysisResult" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "description": "Successfully deleted backup configuration." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/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 backup configuration of an app.", + "description": "Gets the backup configuration of an app.", + "operationId": "WebApps_GetBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7360,19 +8840,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 backup configuration for the production slot.", "required": true, "type": "string" }, @@ -7385,19 +8856,28 @@ ], "responses": { "200": { - "description": "OK." + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + "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/connectionstrings": { + "put": { "tags": [ "WebApps" ], - "summary": "Creates a backup of an app.", - "description": "Creates a backup of an app.", - "operationId": "WebApps_BackupSlot", + "summary": "Replaces the connection strings of an app.", + "description": "Replaces the connection strings of an app.", + "operationId": "WebApps_UpdateConnectionStringsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7410,18 +8890,18 @@ "type": "string" }, { - "name": "request", + "name": "connectionStrings", "in": "body", - "description": "Backup configuration. You can use the JSON response from the POST action as input here.", + "description": "Connection strings of the app or deployment slot. See example.", "required": true, "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/ConnectionStringDictionary" } }, { "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 connection settings for the production slot.", "required": true, "type": "string" }, @@ -7436,7 +8916,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/ConnectionStringDictionary" } }, "default": { @@ -7448,14 +8928,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/connectionstrings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets existing backups of an app.", - "description": "Gets existing backups of an app.", - "operationId": "WebApps_ListBackupsSlot", + "summary": "Gets the connection strings of an app.", + "description": "Gets the connection strings of an app.", + "operationId": "WebApps_ListConnectionStringsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7470,7 +8950,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 get the connection settings for the production slot.", "required": true, "type": "string" }, @@ -7485,7 +8965,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItemCollection" + "$ref": "#/definitions/ConnectionStringDictionary" } }, "default": { @@ -7494,20 +8974,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { "get": { "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": "Gets the logging configuration of an app.", + "description": "Gets the logging configuration of an app.", + "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7519,17 +8996,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 get a backup of 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" }, @@ -7544,7 +9014,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/SiteLogsConfig" } }, "default": { @@ -7555,13 +9025,13 @@ } } }, - "delete": { + "put": { "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": "Updates the logging configuration of an app.", + "description": "Updates the logging configuration of an app.", + "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7574,16 +9044,18 @@ "type": "string" }, { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", + "name": "siteLogsConfig", + "in": "body", + "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } }, { "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 update the logging configuration for the production slot.", "required": true, "type": "string" }, @@ -7596,22 +9068,28 @@ ], "responses": { "200": { - "description": "Successfully deleted web app backup item." + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } }, - "404": { - "description": "Web app backup item 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}/backups/{backupId}/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { + "put": { "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": "Replaces the metadata of an app.", + "description": "Replaces the metadata of an app.", + "operationId": "WebApps_UpdateMetadataSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7619,30 +9097,23 @@ { "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", + "name": "metadata", "in": "body", - "description": "Information on backup request.", + "description": "Edited metadata of the app or deployment slot. See example.", "required": true, "schema": { - "$ref": "#/definitions/BackupRequest" + "$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" }, @@ -7657,7 +9128,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -7669,14 +9140,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { "post": { "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": "Gets the metadata of an app.", + "description": "Gets the metadata of an app.", + "operationId": "WebApps_ListMetadataSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7688,26 +9159,10 @@ "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. 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 the metadata for the production slot.", "required": true, "type": "string" }, @@ -7719,24 +9174,29 @@ } ], "responses": { - "202": { - "description": "Restore operation started." - }, "200": { - "description": "Restore operation started." + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, + "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/publishingcredentials/list": { + "post": { "tags": [ "WebApps" ], - "summary": "List the configurations of an app", - "description": "List the configurations of an app", - "operationId": "WebApps_ListConfigurationsSlot", + "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" @@ -7751,7 +9211,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 publishing credentials for the production slot.", "required": true, "type": "string" }, @@ -7766,7 +9226,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResourceCollection" + "$ref": "./CommonDefinitions.json#/definitions/User" } }, "default": { @@ -7776,19 +9236,17 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { "put": { "tags": [ "WebApps" ], - "summary": "Replaces the application settings of an app.", - "description": "Replaces the application settings of an app.", - "operationId": "WebApps_UpdateApplicationSettingsSlot", + "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" @@ -7796,23 +9254,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "appSettings", + "name": "pushSettings", "in": "body", - "description": "Application settings of the app.", + "description": "Push settings associated with web app.", "required": true, "schema": { - "$ref": "#/definitions/StringDictionary" + "$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 application settings for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -7827,7 +9285,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" } }, "default": { @@ -7839,14 +9297,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the application settings of an app.", - "description": "Gets the application settings of an app.", - "operationId": "WebApps_ListApplicationSettingsSlot", + "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" @@ -7854,14 +9312,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 application settings for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -7876,7 +9334,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" } }, "default": { @@ -7888,14 +9346,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { + "get": { "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": "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" @@ -7903,23 +9361,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "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", - "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 return configuration for the production slot.", "required": true, "type": "string" }, @@ -7934,7 +9383,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -7944,16 +9393,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets the Authentication/Authorization settings of an app.", - "description": "Gets the Authentication/Authorization settings of an app.", - "operationId": "WebApps_GetAuthSettingsSlot", + "summary": "Updates the configuration of an app.", + "description": "Updates the configuration of an app.", + "operationId": "WebApps_CreateOrUpdateConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7965,10 +9412,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 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" }, @@ -7983,7 +9439,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -7993,16 +9449,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": { - "put": { + }, + "patch": { "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": "Updates the configuration of an app.", + "description": "Updates the configuration of an app.", + "operationId": "WebApps_UpdateConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8015,18 +9469,18 @@ "type": "string" }, { - "name": "azureStorageAccounts", + "name": "siteConfig", "in": "body", - "description": "Azure storage accounts of the app.", + "description": "JSON representation of a SiteConfig object. See example.", "required": true, "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + "$ref": "#/definitions/SiteConfigResource" } }, { "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 update configuration for the production slot.", "required": true, "type": "string" }, @@ -8041,7 +9495,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8053,14 +9507,14 @@ } } }, - "/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/web/snapshots": { + "get": { "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": "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" @@ -8075,7 +9529,7 @@ { "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 return configuration for the production slot.", "required": true, "type": "string" }, @@ -8090,7 +9544,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection" } }, "default": { @@ -8099,17 +9553,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/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/web/snapshots/{snapshotId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates the backup configuration of an app.", - "description": "Updates the backup configuration of an app.", - "operationId": "WebApps_UpdateBackupConfigurationSlot", + "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" @@ -8122,18 +9579,16 @@ "type": "string" }, { - "name": "request", - "in": "body", - "description": "Edited backup configuration.", + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } + "type": "string" }, { "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 the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8148,7 +9603,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8158,14 +9613,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": { + "post": { "tags": [ "WebApps" ], - "summary": "Deletes the backup configuration of an app.", - "description": "Deletes the backup configuration of an app.", - "operationId": "WebApps_DeleteBackupConfigurationSlot", + "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" @@ -8177,10 +9634,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 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" }, @@ -8192,20 +9656,23 @@ } ], "responses": { - "200": { - "description": "Successfully deleted backup configuration." + "204": { + "description": "No Content" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the backup configuration of an app.", - "description": "Gets the backup configuration of an app.", - "operationId": "WebApps_GetBackupConfigurationSlot", + "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" @@ -8213,14 +9680,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 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" }, @@ -8232,29 +9699,29 @@ } ], "responses": { + "204": { + "description": "No Content" + }, "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, - "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/connectionstrings": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": { + "post": { "tags": [ "WebApps" ], - "summary": "Replaces the connection strings of an app.", - "description": "Replaces the connection strings of an app.", - "operationId": "WebApps_UpdateConnectionStringsSlot", + "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" @@ -8262,23 +9729,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, - { - "name": "connectionStrings", - "in": "body", - "description": "Connection strings of the app or deployment slot. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } - }, { "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 web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8290,29 +9748,26 @@ } ], "responses": { + "204": { + "description": "No Content" + }, "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } - }, - "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/connectionstrings/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { + "get": { "tags": [ "WebApps" ], - "summary": "Gets the connection strings of an app.", - "description": "Gets the connection strings of an app.", - "operationId": "WebApps_ListConnectionStringsSlot", + "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" @@ -8320,14 +9775,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 connection settings 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" }, @@ -8342,7 +9797,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/ContinuousWebJobCollection" } }, "default": { @@ -8351,17 +9806,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}/continuouswebjobs/{webJobName}": { "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 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" @@ -8369,14 +9827,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 get the logging 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" }, @@ -8389,26 +9854,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Found continuous web job.", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/ContinuousWebJob" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Continuous web job does not exist." } } }, - "put": { + "delete": { "tags": [ "WebApps" ], - "summary": "Updates the logging configuration of an app.", - "description": "Updates the logging configuration of an app.", - "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", + "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" @@ -8416,23 +9878,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "siteLogsConfig", - "in": "body", - "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "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 deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8445,28 +9905,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } + "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/metadata": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": { + "post": { "tags": [ "WebApps" ], - "summary": "Replaces the metadata of an app.", - "description": "Replaces the metadata of an app.", - "operationId": "WebApps_UpdateMetadataSlot", + "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" @@ -8474,23 +9928,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "metadata", - "in": "body", - "description": "Edited metadata of the app or deployment slot. See example.", + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } + "type": "string" }, { "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 the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8503,28 +9955,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } + "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." } } } }, - "/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}/continuouswebjobs/{webJobName}/stop": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the metadata of an app.", - "description": "Gets the metadata of an app.", - "operationId": "WebApps_ListMetadataSlot", + "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" @@ -8532,14 +9978,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 get the metadata 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" }, @@ -8552,28 +10005,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } + "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." } } } }, - "/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}/deployments": { + "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 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" @@ -8588,7 +10035,7 @@ { "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 returns deployments for the production slot.", "required": true, "type": "string" }, @@ -8603,7 +10050,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/User" + "$ref": "#/definitions/DeploymentCollection" } }, "default": { @@ -8613,17 +10060,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}/deployments/{id}": { + "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": "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" @@ -8631,23 +10080,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "pushSettings", - "in": "body", - "description": "Push settings associated with web app.", + "name": "id", + "in": "path", + "description": "Deployment ID.", "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 gets a deployment for the production slot.", "required": true, "type": "string" }, @@ -8662,7 +10109,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + "$ref": "#/definitions/Deployment" } }, "default": { @@ -8672,16 +10119,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets the Push settings associated with web app.", - "description": "Gets the Push settings associated with web app.", - "operationId": "WebApps_ListSitePushSettingsSlot", + "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" @@ -8689,17 +10134,33 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "ID of an existing deployment.", "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 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" }, @@ -8711,7 +10172,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + "$ref": "#/definitions/Deployment" } }, "default": { @@ -8721,31 +10182,36 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { - "get": { + }, + "delete": { "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": "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" }, { - "name": "name", + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", "in": "path", - "description": "Name of the app.", + "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" }, @@ -8758,26 +10224,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "description": "Successfully deleted deployment." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Deployment does not exist." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates the configuration of an app.", - "description": "Updates the configuration of an app.", - "operationId": "WebApps_CreateOrUpdateConfigurationSlot", + "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" @@ -8790,18 +10252,16 @@ "type": "string" }, { - "name": "siteConfig", - "in": "body", - "description": "JSON representation of a SiteConfig object. See example.", + "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, - "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 returns deployments for the production slot.", "required": true, "type": "string" }, @@ -8816,7 +10276,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/Deployment" } }, "default": { @@ -8826,14 +10286,16 @@ } } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates the configuration of an app.", - "description": "Updates the configuration of an app.", - "operationId": "WebApps_UpdateConfigurationSlot", + "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" @@ -8846,18 +10308,18 @@ "type": "string" }, { - "name": "siteConfig", + "name": "request", "in": "body", - "description": "JSON representation of a SiteConfig object. See example.", + "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", "required": true, "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/RestoreRequest" } }, { "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 will perform discovery for the production slot.", "required": true, "type": "string" }, @@ -8872,7 +10334,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/RestoreRequest" } }, "default": { @@ -8884,14 +10346,14 @@ } } }, - "/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}/domainOwnershipIdentifiers": { "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": "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" @@ -8906,7 +10368,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 delete the binding for the production slot.", "required": true, "type": "string" }, @@ -8921,7 +10383,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection" + "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection" } }, "default": { @@ -8936,14 +10398,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { "get": { "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": "Get domain ownership identifier for web app.", + "description": "Get domain ownership identifier for web app.", + "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8956,16 +10418,16 @@ "type": "string" }, { - "name": "snapshotId", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "The ID of the snapshot to read.", + "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 will return configuration 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" }, @@ -8980,7 +10442,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "./CommonDefinitions.json#/definitions/Identifier" } }, "default": { @@ -8990,16 +10452,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": { - "post": { + }, + "put": { "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": "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" @@ -9012,16 +10472,25 @@ "type": "string" }, { - "name": "snapshotId", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "The ID of the snapshot to read.", + "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 will return configuration 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" }, @@ -9033,23 +10502,27 @@ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": { - "post": { + }, + "delete": { "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": "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" @@ -9057,14 +10530,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", "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 will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9076,29 +10556,21 @@ } ], "responses": { - "204": { - "description": "No Content" - }, "200": { - "description": "OK", - "schema": { - "type": "file" - } + "description": "Successfully deleted domain ownership identifier." + }, + "204": { + "description": "Domain ownership identifier does not exist." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": { - "post": { + }, + "patch": { "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": "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" @@ -9106,60 +10578,30 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "slot", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "200": { - "description": "OK", + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, "schema": { - "type": "file" + "$ref": "./CommonDefinitions.json#/definitions/Identifier" } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { - "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", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "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 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 +10616,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ContinuousWebJobCollection" + "$ref": "./CommonDefinitions.json#/definitions/Identifier" } }, "default": { @@ -9183,20 +10625,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { "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 the status of the last MSDeploy operation.", + "description": "Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9204,21 +10643,14 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "webJobName", - "in": "path", - "description": "Name of Web Job.", + "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 deletes 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" }, @@ -9231,23 +10663,26 @@ ], "responses": { "200": { - "description": "Found continuous web job.", + "description": "OK", "schema": { - "$ref": "#/definitions/ContinuousWebJob" + "$ref": "#/definitions/MSDeployStatus" } }, - "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": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateMSDeployOperationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9255,23 +10690,25 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "webJobName", + "name": "slot", "in": "path", - "description": "Name of Web Job.", + "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 deletes 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" @@ -9281,23 +10718,27 @@ } ], "responses": { - "200": { - "description": "Successfully deleted continuous web job." + "201": { + "description": "Deployment is scheduled.", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } }, - "204": { - "description": "Continuous web job does not exist." + "409": { + "description": "Another deployment is in progress." } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": { + "get": { "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": "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" @@ -9305,21 +10746,14 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "webJobName", - "in": "path", - "description": "Name of Web Job.", + "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 deletes 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" }, @@ -9332,22 +10766,25 @@ ], "responses": { "200": { - "description": "Found continuous web job." + "description": "MSDeploy log returned.", + "schema": { + "$ref": "#/definitions/MSDeployLog" + } }, "404": { - "description": "Continuous web job does not exist." + "description": "MSDeploy log not found." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": { + "get": { "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": "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" @@ -9359,17 +10796,10 @@ "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 deletes a deployment for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -9382,22 +10812,28 @@ ], "responses": { "200": { - "description": "Found continuous web job." + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelopeCollection" + } }, "404": { - "description": "Continuous web job does not exist." + "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": { "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": "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" @@ -9405,14 +10841,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 +10863,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DeploymentCollection" + "type": "string" } }, "default": { @@ -9436,20 +10872,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": { "get": { "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": "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" @@ -9457,21 +10890,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "id", + "name": "functionName", "in": "path", - "description": "Deployment ID.", + "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 gets a deployment for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -9484,16 +10917,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function information returned.", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/FunctionEnvelope" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Function with a name of {functionName} does not exist." } } }, @@ -9501,9 +10931,9 @@ "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": "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" @@ -9511,31 +10941,31 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "id", + "name": "functionName", "in": "path", - "description": "ID of an existing deployment.", + "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 creates a deployment for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, { - "name": "deployment", + "name": "function_envelope", "in": "body", - "description": "Deployment details.", + "description": "Function details.", "required": true, "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/FunctionEnvelope" } }, { @@ -9546,10 +10976,10 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Function created.", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/FunctionEnvelope" } }, "default": { @@ -9558,15 +10988,16 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - } + }, + "x-ms-long-running-operation": true }, "delete": { "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": "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" @@ -9574,21 +11005,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "id", + "name": "functionName", "in": "path", - "description": "Deployment ID.", + "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.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -9600,79 +11031,23 @@ } ], "responses": { - "200": { - "description": "Successfully deleted deployment." - }, "204": { - "description": "Deployment does not exist." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": { - "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", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "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\".", - "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.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } + "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}/discoverbackup": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}": { + "put": { "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": "Add or update a function secret.", + "description": "Add or update a function secret.", + "operationId": "WebApps_CreateOrUpdateFunctionSecretSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9680,26 +11055,40 @@ { "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": "The name of the function.", "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } + "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 will perform discovery 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" }, @@ -9708,10 +11097,16 @@ } ], "responses": { + "201": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, "200": { - "description": "OK", + "description": "Key was updated.", "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -9721,16 +11116,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { - "get": { + }, + "delete": { "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": "Delete a function secret.", + "description": "Delete a function secret.", + "operationId": "WebApps_DeleteFunctionSecretSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9738,14 +11131,28 @@ { "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" }, { "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" }, @@ -9757,32 +11164,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection" - } + "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}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Get domain ownership identifier for web app.", - "description": "Get domain ownership identifier for web app.", - "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", + "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" @@ -9790,21 +11188,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.", "required": true, "type": "string" }, @@ -9817,9 +11215,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function keys returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -9829,14 +11227,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": { + "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_CreateOrUpdateDomainOwnershipIdentifierSlot", + "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" @@ -9844,30 +11244,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" }, @@ -9880,9 +11271,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function secrets returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" + "$ref": "#/definitions/FunctionSecrets" } }, "default": { @@ -9892,14 +11283,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/properties/state": { + "get": { "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": "Get the enablement state for a function.", + "description": "Get the enablement state for a function.", + "operationId": "WebApps_GetFunctionStateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9907,21 +11300,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.", "required": true, "type": "string" }, @@ -9934,20 +11327,23 @@ ], "responses": { "200": { - "description": "Successfully deleted domain ownership identifier." + "description": "Function state returned.", + "schema": { + "type": "string" + } }, - "204": { - "description": "Domain ownership identifier does not exist." + "404": { + "description": "Function with a name of {functionName} does not exist." } } }, - "patch": { + "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_UpdateDomainOwnershipIdentifierSlot", + "summary": "Set the enablement state for a function.", + "description": "Set the enablement state for a function.", + "operationId": "WebApps_UpdateFunctionStateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9955,30 +11351,29 @@ { "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", + "name": "requestEnvelope", "in": "body", - "description": "A JSON representation of the domain ownership properties.", "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" }, @@ -9991,28 +11386,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "The function state was updated.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" + "type": "string" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Function with a name of {functionName} does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/properties/status": { "get": { "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 status.", + "description": "Get function status.", + "operationId": "WebApps_GetFunctionStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10020,14 +11412,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,26 +11439,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function status returned.", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/FunctionStatus" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Function with a name of {functionName} does not exist." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension.", - "description": "Invoke the MSDeploy web app extension.", - "operationId": "WebApps_CreateMSDeployOperationSlot", + "summary": "Get host secrets for a function app.", + "description": "Get host secrets for a function app.", + "operationId": "WebApps_ListHostKeysSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10067,26 +11465,17 @@ { "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" }, - { - "name": "MSDeploy", - "in": "body", - "description": "Details of MSDeploy operation", - "required": true, - "schema": { - "$ref": "#/definitions/MSDeploy" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -10095,27 +11484,29 @@ } ], "responses": { - "201": { - "description": "Deployment is scheduled.", + "200": { + "description": "Host secrets returned.", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/HostKeys" } }, - "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}/slots/{slot}/extensions/MSDeploy/log": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus": { + "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": "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" @@ -10123,14 +11514,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "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" }, @@ -10142,26 +11533,20 @@ } ], "responses": { - "200": { - "description": "MSDeploy log returned.", - "schema": { - "$ref": "#/definitions/MSDeployLog" - } - }, - "404": { - "description": "MSDeploy log not found." + "204": { + "description": "No Content" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/properties/config": { "get": { "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": "Get the host configuration (host.json).", + "description": "Get the host configuration (host.json).", + "operationId": "WebApps_GetHostConfigSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10176,7 +11561,7 @@ { "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" }, @@ -10189,28 +11574,28 @@ ], "responses": { "200": { - "description": "Function information returned.", + "description": "Host configuration returned.", "schema": { - "$ref": "#/definitions/FunctionEnvelopeCollection" + "type": "object" } }, - "404": { - "description": "Function with an ID of {functionName} 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}/slots/{slot}/functions/admin/token": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/properties/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": "Get the host status.", + "description": "Get the host status.", + "operationId": "WebApps_GetHostStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10218,14 +11603,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" }, @@ -10238,9 +11623,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "Host status returned.", "schema": { - "type": "string" + "$ref": "#/definitions/HostStatus" } }, "default": { @@ -10252,14 +11637,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 +11652,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.", "required": true, "type": "string" }, @@ -10293,24 +11671,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 +11697,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" } }, { @@ -10354,9 +11735,15 @@ ], "responses": { "201": { - "description": "Function created.", + "description": "Key was created.", "schema": { - "$ref": "#/definitions/FunctionEnvelope" + "$ref": "#/definitions/KeyInfo" + } + }, + "200": { + "description": "Key was updated.", + "schema": { + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -10365,16 +11752,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" @@ -10387,66 +11773,23 @@ "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" - }, - { - "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 +11801,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." } } } @@ -12125,7 +13462,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.", "required": true, "type": "string" }, @@ -15477,8 +16814,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": [ { @@ -15494,7 +16831,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.", "required": true, "type": "string" }, @@ -17109,8 +18446,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": [ { @@ -18817,7 +20154,7 @@ } }, "FunctionEnvelope": { - "description": "Web Job Information.", + "description": "Function information.", "type": "object", "allOf": [ { @@ -18844,6 +20181,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 +20207,18 @@ "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" + }, + "isDisabled": { + "description": "Value indicating whether the function is disabled", + "type": "boolean" } }, "x-ms-client-flatten": true @@ -18918,6 +20271,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 +20470,46 @@ } } }, + "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" + }, + "errors": { + "description": "Collection of initialization errors for the host.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + } + } + }, "HttpLogsConfig": { "description": "Http logs configuration.", "type": "object", @@ -19072,6 +20524,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", @@ -20925,7 +22402,7 @@ "items": { "$ref": "./CommonDefinitions.json#/definitions/GeoDistribution" } - } + } }, "x-ms-client-flatten": true }, @@ -21686,4 +23163,4 @@ ] } ] -} +} \ No newline at end of file From 8a6390065e2c534eaf2d954b3657c646a5767555 Mon Sep 17 00:00:00 2001 From: Mathew Charles Date: Thu, 26 Sep 2019 12:32:41 -0700 Subject: [PATCH 2/4] Addressing feedback --- .../stable/2018-02-01/WebApps.json | 162 +++++++----------- 1 file changed, 65 insertions(+), 97 deletions(-) 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 9b6640f2c7df..eb27c3f53401 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 @@ -3361,6 +3361,12 @@ }, "404": { "description": "Function with a name of {functionName} does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } }, @@ -3413,6 +3419,12 @@ }, "404": { "description": "Function with a name of {functionName} does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } @@ -20274,59 +20286,37 @@ "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 + "errors": { + "description": "Collection of initialization errors for the function.", + "type": "array", + "items": { + "type": "string" + } } - } + } }, "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 + "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" + } } } }, @@ -20473,40 +20463,29 @@ "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" - }, - "errors": { - "description": "Collection of initialization errors for the host.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-flatten": true + "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" + }, + "errors": { + "description": "Collection of initialization errors for the host.", + "type": "array", + "items": { + "type": "string" + } } } }, @@ -20527,25 +20506,14 @@ "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 + "name": { + "description": "Key name", + "type": "string" + }, + "value": { + "description": "Key value", + "type": "string" } } }, From 953c4edf52409f19f374317465cd1f08e575e1f1 Mon Sep 17 00:00:00 2001 From: Mathew Charles Date: Thu, 26 Sep 2019 14:16:56 -0700 Subject: [PATCH 3/4] Addressing feedback --- .../stable/2018-02-01/WebApps.json | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) 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 eb27c3f53401..e2d573abf215 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 @@ -3546,6 +3546,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } @@ -3782,6 +3788,12 @@ }, "204": { "description": "Key was deleted." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } @@ -11346,6 +11358,12 @@ }, "404": { "description": "Function with a name of {functionName} does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } }, @@ -11405,6 +11423,12 @@ }, "404": { "description": "Function with a name of {functionName} does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } @@ -11458,6 +11482,12 @@ }, "404": { "description": "Function with a name of {functionName} does not exist." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } @@ -11547,6 +11577,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } @@ -11685,6 +11721,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } @@ -11818,6 +11860,12 @@ }, "204": { "description": "Key was deleted." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } From b1da08951a0828c7f9e0678549b54d137e15961a Mon Sep 17 00:00:00 2001 From: Mathew Charles Date: Fri, 4 Oct 2019 12:53:19 -0700 Subject: [PATCH 4/4] Removing contentions APIs from spec --- .../stable/2018-02-01/WebApps.json | 563 ------------------ 1 file changed, 563 deletions(-) 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 e2d573abf215..ca580ebea02f 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 @@ -3319,162 +3319,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/properties/state": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Get the enablement state for a function.", - "description": "Get the enablement state for a function.", - "operationId": "WebApps_GetFunctionState", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "functionName", - "in": "path", - "description": "Function name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Function state returned.", - "schema": { - "type": "string" - } - }, - "404": { - "description": "Function with a name of {functionName} does not exist." - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "WebApps" - ], - "summary": "Set the enablement state for a function.", - "description": "Set the enablement state for a function.", - "operationId": "WebApps_UpdateFunctionState", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "functionName", - "in": "path", - "description": "Function name.", - "required": true, - "type": "string" - }, - { - "name": "requestEnvelope", - "in": "body", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The function state was updated.", - "schema": { - "type": "string" - } - }, - "404": { - "description": "Function with a name of {functionName} does not exist." - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/properties/status": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Get function status.", - "description": "Get function status.", - "operationId": "WebApps_GetFunctionStatus", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "functionName", - "in": "path", - "description": "Function name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Function status returned.", - "schema": { - "$ref": "#/definitions/FunctionStatus" - } - }, - "404": { - "description": "Function with a name of {functionName} does not exist." - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys": { "post": { "tags": [ @@ -3556,90 +3400,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/properties/config": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Get the host configuration (host.json).", - "description": "Get the host configuration (host.json).", - "operationId": "WebApps_GetHostConfig", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Host configuration returned.", - "schema": { - "type": "object" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/properties/status": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Get the host status.", - "description": "Get the host status.", - "operationId": "WebApps_GetHostStatus", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Host status returned.", - "schema": { - "$ref": "#/definitions/HostStatus" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync": { "post": { "tags": [ @@ -11309,189 +11069,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/properties/state": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Get the enablement state for a function.", - "description": "Get the enablement state for a function.", - "operationId": "WebApps_GetFunctionStateSlot", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "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.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Function state returned.", - "schema": { - "type": "string" - } - }, - "404": { - "description": "Function with a name of {functionName} does not exist." - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "WebApps" - ], - "summary": "Set the enablement state for a function.", - "description": "Set the enablement state for a function.", - "operationId": "WebApps_UpdateFunctionStateSlot", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "functionName", - "in": "path", - "description": "Function name.", - "required": true, - "type": "string" - }, - { - "name": "requestEnvelope", - "in": "body", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The function state was updated.", - "schema": { - "type": "string" - } - }, - "404": { - "description": "Function with a name of {functionName} 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}/functions/{functionName}/properties/status": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Get function status.", - "description": "Get function status.", - "operationId": "WebApps_GetFunctionStatusSlot", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "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.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Function status returned.", - "schema": { - "$ref": "#/definitions/FunctionStatus" - } - }, - "404": { - "description": "Function with a name of {functionName} 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}/host/default/listkeys": { "post": { "tags": [ @@ -11587,104 +11164,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/properties/config": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Get the host configuration (host.json).", - "description": "Get the host configuration (host.json).", - "operationId": "WebApps_GetHostConfigSlot", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Host configuration returned.", - "schema": { - "type": "object" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/properties/status": { - "get": { - "tags": [ - "WebApps" - ], - "summary": "Get the host status.", - "description": "Get the host status.", - "operationId": "WebApps_GetHostStatusSlot", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Host status returned.", - "schema": { - "$ref": "#/definitions/HostStatus" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync": { "post": { "tags": [ @@ -20331,19 +19810,6 @@ } } }, - "FunctionStatus": { - "description": "Function status.", - "type": "object", - "properties": { - "errors": { - "description": "Collection of initialization errors for the function.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, "HostKeys": { "description": "Functions host level keys.", "type": "object", @@ -20508,35 +19974,6 @@ } } }, - "HostStatus": { - "description": "Function host status.", - "type": "object", - "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" - }, - "errors": { - "description": "Collection of initialization errors for the host.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, "HttpLogsConfig": { "description": "Http logs configuration.", "type": "object",