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..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 @@ -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}/host/default/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Deletes a hostname binding for an app.", - "description": "Deletes a hostname binding for an app.", - "operationId": "WebApps_DeleteHostNameBinding", + "summary": "Get host secrets for a function app.", + "description": "Get host secrets for a function app.", + "operationId": "WebApps_ListHostKeys", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3314,14 +3334,7 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "hostName", - "in": "path", - "description": "Hostname in the hostname binding.", + "description": "Site name.", "required": true, "type": "string" }, @@ -3334,22 +3347,28 @@ ], "responses": { "200": { - "description": "Successfully deleted hostname binding." + "description": "Host secrets returned.", + "schema": { + "$ref": "#/definitions/HostKeys" + } }, - "204": { - "description": "Hostname binding does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus": { + "post": { "tags": [ "WebApps" ], - "summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.", - "description": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.", - "operationId": "WebApps_GetHybridConnection", + "summary": "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" @@ -3357,21 +3376,46 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection.", - "required": true, - "type": "string" + "$ref": "#/parameters/subscriptionIdParameter" }, { - "name": "relayName", + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "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": [ + "WebApps" + ], + "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" + }, + { + "name": "name", "in": "path", - "description": "The relay name for this hybrid connection.", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -3383,27 +3427,20 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "No Content" } } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}": { "put": { "tags": [ "WebApps" ], - "summary": "Creates a new Hybrid Connection using a Service Bus relay.", - "description": "Creates a new Hybrid Connection using a Service Bus relay.", - "operationId": "WebApps_CreateOrUpdateHybridConnection", + "summary": "Add or update a host level secret.", + "description": "Add or update a host level secret.", + "operationId": "WebApps_CreateOrUpdateHostSecret", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3411,31 +3448,31 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "namespaceName", + "name": "keyType", "in": "path", - "description": "The namespace for this hybrid connection.", + "description": "The type of host key.", "required": true, "type": "string" }, { - "name": "relayName", + "name": "keyName", "in": "path", - "description": "The relay name for this hybrid connection.", + "description": "The name of the key.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", + "name": "key", "in": "body", - "description": "The details of the hybrid connection.", + "description": "The key to create or update", "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/KeyInfo" } }, { @@ -3446,10 +3483,16 @@ } ], "responses": { + "201": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, "200": { - "description": "OK", + "description": "Key was updated.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -3464,9 +3507,9 @@ "tags": [ "WebApps" ], - "summary": "Removes a Hybrid Connection from this site.", - "description": "Removes a Hybrid Connection from this site.", - "operationId": "WebApps_DeleteHybridConnection", + "summary": "Delete a host level secret.", + "description": "Delete a host level secret.", + "operationId": "WebApps_DeleteHostSecret", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3474,21 +3517,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "namespaceName", + "name": "keyType", "in": "path", - "description": "The namespace for this hybrid connection.", + "description": "The type of host key.", "required": true, "type": "string" }, { - "name": "relayName", + "name": "keyName", "in": "path", - "description": "The relay name for this hybrid connection.", + "description": "The name of the key.", "required": true, "type": "string" }, @@ -3500,21 +3543,29 @@ } ], "responses": { - "200": { - "description": "Successfully deleted hybrid connection." - }, "404": { - "description": "Hybrid connection does not exist." + "description": "Key was not found." + }, + "204": { + "description": "Key was deleted." + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { + "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 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" @@ -3522,35 +3573,12 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection.", - "required": true, - "type": "string" - }, - { - "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/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" @@ -3560,7 +3588,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/HostNameBindingCollection" } }, "default": { @@ -3569,17 +3597,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { + "get": { "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": "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" @@ -3587,21 +3618,14 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", - "required": true, - "type": "string" - }, - { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "relayName", + "name": "hostName", "in": "path", - "description": "The relay name for this hybrid connection.", + "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, @@ -3616,7 +3640,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnectionKey" + "$ref": "#/definitions/HostNameBinding" } }, "default": { @@ -3626,16 +3650,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": { - "get": { + }, + "put": { "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": "Creates a hostname binding for an app.", + "description": "Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdateHostNameBinding", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3643,10 +3665,26 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Hostname in the hostname binding.", "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" }, @@ -3658,7 +3696,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" + "$ref": "#/definitions/HostNameBinding" } }, "default": { @@ -3668,16 +3706,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { - "get": { + }, + "delete": { "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": "Deletes a hostname binding for an app.", + "description": "Deletes a hostname binding for an app.", + "operationId": "WebApps_DeleteHostNameBinding", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3689,6 +3725,13 @@ "required": true, "type": "string" }, + { + "name": "hostName", + "in": "path", + "description": "Hostname in the hostname binding.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3698,28 +3741,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } + "description": "Successfully deleted hostname binding." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Hostname binding does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { "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": "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" @@ -3727,14 +3764,21 @@ { "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.", + "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" }, @@ -3749,7 +3793,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { @@ -3764,9 +3808,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 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" @@ -3774,24 +3818,31 @@ { "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": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", - "description": "Details of the hybrid connection configuration.", + "description": "The details of the hybrid connection.", "required": true, "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, { @@ -3805,7 +3856,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { @@ -3820,9 +3871,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": "Removes a Hybrid Connection from this site.", + "description": "Removes a Hybrid Connection from this site.", + "operationId": "WebApps_DeleteHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3830,14 +3881,21 @@ { "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": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, @@ -3850,10 +3908,10 @@ ], "responses": { "200": { - "description": "Successfully deleted relay service connection." + "description": "Successfully deleted hybrid connection." }, "404": { - "description": "Relay service connection does not exist." + "description": "Hybrid connection does not exist." } } }, @@ -3861,9 +3919,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_UpdateRelayServiceConnection", + "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" @@ -3871,24 +3929,31 @@ { "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": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", - "description": "Details of the hybrid connection configuration.", + "description": "The details of the hybrid connection.", "required": true, "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, { @@ -3902,7 +3967,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { @@ -3914,14 +3979,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets all scale-out instances of an app.", - "description": "Gets all scale-out instances of an app.", - "operationId": "WebApps_ListInstanceIdentifiers", + "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" @@ -3929,7 +3994,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, @@ -3944,7 +4023,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WebAppInstanceCollection" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnectionKey" } }, "default": { @@ -3953,20 +4032,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": { "get": { "tags": [ "WebApps" ], - "summary": "Get the status of the last MSDeploy operation.", - "description": "Get the status of the last MSDeploy operation.", - "operationId": "WebApps_GetInstanceMsDeployStatus", + "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" @@ -3974,14 +4050,7 @@ { "name": "name", "in": "path", - "description": "Name of web app.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "ID of web app instance.", + "description": "The name of the web app.", "required": true, "type": "string" }, @@ -3996,7 +4065,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "./CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { @@ -4006,14 +4075,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { + "get": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension.", - "description": "Invoke the MSDeploy web app extension.", - "operationId": "WebApps_CreateInstanceMSDeployOperation", + "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" @@ -4021,26 +4092,10 @@ { "name": "name", "in": "path", - "description": "Name of web app.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "ID of web app instance.", + "description": "Name of the app.", "required": true, "type": "string" }, - { - "name": "MSDeploy", - "in": "body", - "description": "Details of MSDeploy operation", - "required": true, - "schema": { - "$ref": "#/definitions/MSDeploy" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -4049,27 +4104,29 @@ } ], "responses": { - "201": { - "description": "Deployment is scheduled.", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/RelayServiceConnectionEntity" } }, - "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { "get": { "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 a hybrid connection configuration by its name.", + "description": "Gets a hybrid connection configuration by its name.", + "operationId": "WebApps_GetRelayServiceConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4077,14 +4134,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "entityName", "in": "path", - "description": "ID of web app instance.", + "description": "Name of the hybrid connection.", "required": true, "type": "string" }, @@ -4097,25 +4154,26 @@ ], "responses": { "200": { - "description": "MSDeploy log returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployLog" + "$ref": "#/definitions/RelayServiceConnectionEntity" } }, - "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": { - "get": { + }, + "put": { "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": "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" @@ -4123,17 +4181,26 @@ { "name": "name", "in": "path", - "description": "Site name.", + "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" }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -4143,28 +4210,26 @@ ], "responses": { "200": { - "description": "Process terminated.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessInfoCollection" + "$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" + } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": { - "get": { + }, + "delete": { "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": "Deletes a relay service connection by its name.", + "description": "Deletes a relay service connection by its name.", + "operationId": "WebApps_DeleteRelayServiceConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4172,21 +4237,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" }, @@ -4199,23 +4257,20 @@ ], "responses": { "200": { - "description": "Process information returned.", - "schema": { - "$ref": "#/definitions/ProcessInfo" - } + "description": "Successfully deleted relay service connection." }, "404": { - "description": "Process with the specified ID is not running." + "description": "Relay service connection does not exist." } } }, - "delete": { + "patch": { "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": "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" @@ -4223,23 +4278,25 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", + "name": "entityName", "in": "path", - "description": "PID.", + "description": "Name of the hybrid connection configuration.", "required": true, "type": "string" }, { - "name": "instanceId", - "in": "path", - "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4249,23 +4306,29 @@ } ], "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { "get": { "tags": [ "WebApps" ], - "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", - "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_GetInstanceProcessDump", + "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" @@ -4273,21 +4336,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" }, @@ -4302,23 +4351,29 @@ "200": { "description": "OK", "schema": { - "type": "file" + "$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": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], - "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", - "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListInstanceProcessModules", + "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" @@ -4326,21 +4381,14 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "processId", - "in": "path", - "description": "PID.", + "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" }, @@ -4353,28 +4401,26 @@ ], "responses": { "200": { - "description": "Module information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessModuleInfoCollection" + "$ref": "#/definitions/MSDeployStatus" } }, - "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}/modules/{baseAddress}": { - "get": { - "tags": [ + }, + "put": { + "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": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateInstanceMSDeployOperation", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4382,28 +4428,70 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "processId", + "name": "instanceId", "in": "path", - "description": "PID.", + "description": "ID of web app instance.", "required": true, "type": "string" }, { - "name": "baseAddress", + "name": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", + "required": true, + "schema": { + "$ref": "#/definitions/MSDeploy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Deployment is scheduled.", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } + }, + "409": { + "description": "Another deployment is in progress." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": { + "get": { + "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", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", "in": "path", - "description": "Module base address.", + "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" }, @@ -4416,25 +4504,25 @@ ], "responses": { "200": { - "description": "Module information returned.", + "description": "MSDeploy log returned.", "schema": { - "$ref": "#/definitions/ProcessModuleInfo" + "$ref": "#/definitions/MSDeployLog" } }, "404": { - "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." + "description": "MSDeploy log not found." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": { "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": "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" @@ -4446,13 +4534,6 @@ "required": true, "type": "string" }, - { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, { "name": "instanceId", "in": "path", @@ -4469,9 +4550,9 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "Process terminated.", "schema": { - "$ref": "#/definitions/ProcessThreadInfoCollection" + "$ref": "#/definitions/ProcessInfoCollection" } }, "404": { @@ -4483,14 +4564,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}/processes/{processId}": { "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 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" @@ -4509,13 +4590,6 @@ "required": true, "type": "string" }, - { - "name": "threadId", - "in": "path", - "description": "TID.", - "required": true, - "type": "string" - }, { "name": "instanceId", "in": "path", @@ -4532,25 +4606,23 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "Process information returned.", "schema": { - "$ref": "#/definitions/ProcessThreadInfo" + "$ref": "#/definitions/ProcessInfo" } }, "404": { - "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." + "description": "Process with the specified ID is not running." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { - "post": { + }, + "delete": { "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": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", + "operationId": "WebApps_DeleteInstanceProcess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4558,7 +4630,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": "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" }, @@ -4570,29 +4656,23 @@ } ], "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/SiteCloneability" - } + "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." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": { + "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 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" @@ -4600,7 +4680,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": "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" }, @@ -4615,26 +4709,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/FunctionSecrets" + "type": "file" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": { "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": "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" @@ -4642,7 +4733,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": "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 +4760,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection" + "$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": { @@ -4672,14 +4774,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": { "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_GetInstanceProcessModule", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4687,25 +4789,33 @@ { "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": "baseAddress", + "in": "path", + "description": "Module base address.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" @@ -4713,57 +4823,49 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricCollection" + "$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." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": { + "get": { "tags": [ "WebApps" ], - "summary": "Restores a web app.", - "description": "Restores a web app.", - "operationId": "WebApps_MigrateStorage", + "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": [ - { - "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" @@ -4774,29 +4876,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "#/definitions/StorageMigrationResponse" + "$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-long-running-operation": true + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads/{threadId}": { + "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 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" @@ -4804,18 +4905,30 @@ { "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": "threadId", + "in": "path", + "description": "TID.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4826,29 +4939,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "$ref": "#/definitions/ProcessThreadInfo" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { + "post": { "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": "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" @@ -4856,7 +4965,7 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -4869,9 +4978,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { - "$ref": "#/definitions/MigrateMySqlStatus" + "$ref": "#/definitions/SiteCloneability" } }, "default": { @@ -4883,14 +4992,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets a Swift Virtual Network connection.", - "description": "Gets a Swift Virtual Network connection.", - "operationId": "WebApps_GetSwiftVirtualNetworkConnection", + "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" @@ -4911,9 +5020,9 @@ ], "responses": { "200": { - "description": "OK.", + "description": "OK", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "#/definitions/FunctionSecrets" } }, "default": { @@ -4923,14 +5032,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { + "get": { "tags": [ "WebApps" ], - "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", - "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", - "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnection", + "summary": "Gets 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" @@ -4942,15 +5053,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" }, @@ -4962,7 +5064,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection" } }, "default": { @@ -4971,15 +5073,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "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": "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" @@ -4991,6 +5098,19 @@ "required": true, "type": "string" }, + { + "name": "details", + "in": "query", + "description": "Specify \"true\" to include metric details in the response. It is \"false\" by default.", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only metrics specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string", + "x-ms-skip-url-encoding": true + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5000,38 +5120,56 @@ ], "responses": { "200": { - "description": "Successfully deleted virtual network." + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ResourceMetricCollection" + } }, - "404": { - "description": "Virtual network does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": { + "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_UpdateSwiftVirtualNetworkConnection", + "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": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", + "name": "migrationOptions", "in": "body", - "description": "Properties of the Virtual Network connection. See example.", + "description": "Migration migrationOptions.", "required": true, "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "#/definitions/StorageMigrationOptions" } }, { @@ -5045,7 +5183,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SwiftVirtualNetwork" + "$ref": "#/definitions/StorageMigrationResponse" } }, "default": { @@ -5054,17 +5192,18 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { + "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": "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" @@ -5072,16 +5211,18 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "view", - "in": "path", - "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "name": "migrationRequestEnvelope", + "in": "body", + "description": "MySql migration options.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MigrateMySqlRequest" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -5092,25 +5233,29 @@ ], "responses": { "200": { - "description": "OK.", + "description": "OK", "schema": { - "$ref": "#/definitions/NetworkFeatures" + "$ref": "./CommonDefinitions.json#/definitions/Operation" } }, - "404": { - "description": "The requested view does not exist." + "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}/networkTrace/operationresults/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": { "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": "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" @@ -5118,14 +5263,7 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "GUID of the operation.", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -5140,19 +5278,7 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } - }, - "202": { - "description": "Operation is in progress.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$ref": "#/definitions/MigrateMySqlStatus" } }, "default": { @@ -5161,22 +5287,17 @@ "$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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": { + "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 a Swift Virtual Network connection.", + "description": "Gets a Swift Virtual Network connection.", + "operationId": "WebApps_GetSwiftVirtualNetworkConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5184,30 +5305,10 @@ { "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", - "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" }, @@ -5217,9 +5318,9 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { - "type": "string" + "$ref": "#/definitions/SwiftVirtualNetwork" } }, "default": { @@ -5229,16 +5330,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Start capturing network packets for the site.", - "description": "Start capturing network packets for the site.", - "operationId": "WebApps_StartWebSiteNetworkTraceOperation", + "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" @@ -5246,29 +5345,18 @@ { "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", - "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": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -5281,19 +5369,7 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } - }, - "202": { - "description": "Operation is in progress.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$ref": "#/definitions/SwiftVirtualNetwork" } }, "default": { @@ -5302,23 +5378,15 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-examples": { - "Start a new network trace operation for a site": { - "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": { - "post": { + } + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Stop ongoing capturing network packets for the site.", - "description": "Stop ongoing capturing network packets for the site.", - "operationId": "WebApps_StopWebSiteNetworkTrace", + "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" @@ -5326,7 +5394,7 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -5339,27 +5407,20 @@ ], "responses": { "200": { - "description": "Stopped." + "description": "Successfully deleted virtual network." }, - "204": { - "description": "Stopped." - } - }, - "x-ms-examples": { - "Stop a currently running network trace operation for a site": { - "$ref": "./examples/StopWebSiteNetworkTrace.json" + "404": { + "description": "Virtual network does not exist." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}": { - "get": { + }, + "patch": { "tags": [ "WebApps" ], - "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", - "operationId": "WebApps_GetNetworkTraces", + "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" @@ -5372,11 +5433,13 @@ "type": "string" }, { - "name": "operationId", - "in": "path", - "description": "GUID of the operation.", + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -5389,10 +5452,7 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$ref": "#/definitions/SwiftVirtualNetwork" } }, "default": { @@ -5401,22 +5461,17 @@ "$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}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { "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": "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" @@ -5429,9 +5484,9 @@ "type": "string" }, { - "name": "operationId", + "name": "view", "in": "path", - "description": "GUID of the operation.", + "description": "The type of view. This can either be \"summary\" or \"detailed\".", "required": true, "type": "string" }, @@ -5444,45 +5499,25 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } - } - }, - "202": { - "description": "Operation is in progress.", + "description": "OK.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkTrace" - } + "$ref": "#/definitions/NetworkFeatures" } }, - "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": "The requested view does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": { + "/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_GetNetworkTracesV2", + "operationId": "WebApps_GetNetworkTraceOperation", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5518,6 +5553,15 @@ } } }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, "default": { "description": "App Service error response.", "schema": { @@ -5526,20 +5570,20 @@ } }, "x-ms-examples": { - "Get NetworkTraces for a site": { - "$ref": "./examples/GetWebSiteNetworkTraces.json" + "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}/newpassword": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": { "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", + "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" @@ -5547,10 +5591,30 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "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" }, @@ -5560,22 +5624,28 @@ ], "responses": { "200": { - "description": "Successfully generate new password." + "description": "OK", + "schema": { + "type": "string" + } }, - "204": { - "description": "Successfully generate new password." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets perfmon counters for web app.", - "description": "Gets perfmon counters for web app.", - "operationId": "WebApps_ListPerfMonCounters", + "summary": "Start capturing network packets for the site.", + "description": "Start capturing network packets for the site.", + "operationId": "WebApps_StartWebSiteNetworkTraceOperation", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5583,16 +5653,29 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "name": "$filter", + "name": "durationInSeconds", "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 + "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" @@ -5605,7 +5688,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PerfMonCounterCollection" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -5615,19 +5710,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } + "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}/phplogging": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets web app's event logs.", - "description": "Gets web app's event logs.", - "operationId": "WebApps_GetSitePhpErrorLogFlag", + "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" @@ -5635,7 +5733,7 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "The name of the web app.", "required": true, "type": "string" }, @@ -5648,28 +5746,27 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SitePhpErrorLogFlag" - } + "description": "Stopped." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "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}/premieraddons": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the premier add-ons of an app.", - "description": "Gets the premier add-ons of an app.", - "operationId": "WebApps_ListPremierAddOns", + "summary": "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" @@ -5681,6 +5778,13 @@ "required": true, "type": "string" }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5692,7 +5796,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -5701,17 +5808,22 @@ "$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}/premieraddons/{premierAddOnName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a named add-on of an app.", - "description": "Gets a named add-on of an app.", - "operationId": "WebApps_GetPremierAddOn", + "summary": "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" @@ -5724,9 +5836,9 @@ "type": "string" }, { - "name": "premierAddOnName", + "name": "operationId", "in": "path", - "description": "Add-on name.", + "description": "GUID of the operation.", "required": true, "type": "string" }, @@ -5741,7 +5853,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -5750,15 +5874,22 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates a named add-on of an app.", - "description": "Updates a named add-on of an app.", - "operationId": "WebApps_AddPremierAddOn", + "summary": "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" @@ -5771,21 +5902,12 @@ "type": "string" }, { - "name": "premierAddOnName", + "name": "operationId", "in": "path", - "description": "Add-on name.", + "description": "GUID of the operation.", "required": true, "type": "string" }, - { - "name": "premierAddOn", - "in": "body", - "description": "A JSON representation of the edited premier add-on.", - "required": true, - "schema": { - "$ref": "#/definitions/PremierAddOn" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5797,7 +5919,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -5806,15 +5931,22 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { + "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": "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" @@ -5826,13 +5958,6 @@ "required": true, "type": "string" }, - { - "name": "premierAddOnName", - "in": "path", - "description": "Add-on name.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5842,17 +5967,22 @@ ], "responses": { "200": { - "description": "Successfully deleted premier add-on." - } + "description": "Successfully generate new password." + }, + "204": { + "description": "Successfully generate new password." + } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates a named add-on of an app.", - "description": "Updates a named add-on of an app.", - "operationId": "WebApps_UpdatePremierAddOn", + "summary": "Gets perfmon counters for web app.", + "description": "Gets perfmon counters for web app.", + "operationId": "WebApps_ListPerfMonCounters", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5860,25 +5990,16 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", - "description": "Add-on name.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "premierAddOn", - "in": "body", - "description": "A JSON representation of the edited premier add-on.", - "required": true, - "schema": { - "$ref": "#/definitions/PremierAddOnPatchResource" - } + "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" @@ -5891,7 +6012,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/PerfMonCounterCollection" } }, "default": { @@ -5900,17 +6021,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": { "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", + "summary": "Gets web app's event logs.", + "description": "Gets web app's event logs.", + "operationId": "WebApps_GetSitePhpErrorLogFlag", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5918,7 +6042,7 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -5933,7 +6057,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PrivateAccess" + "$ref": "#/definitions/SitePhpErrorLogFlag" } }, "default": { @@ -5943,14 +6067,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { + "get": { "tags": [ "WebApps" ], - "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", - "description": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", - "operationId": "WebApps_PutPrivateAccessVnet", + "summary": "Gets the premier add-ons of an app.", + "description": "Gets the premier add-ons of an app.", + "operationId": "WebApps_ListPremierAddOns", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5958,19 +6084,10 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the 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" }, @@ -5982,7 +6099,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PrivateAccess" + "$ref": "#/definitions/PremierAddOn" } }, "default": { @@ -5994,14 +6111,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { "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", + "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" @@ -6009,7 +6126,14 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", "required": true, "type": "string" }, @@ -6022,28 +6146,26 @@ ], "responses": { "200": { - "description": "Process terminated.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessInfoCollection" + "$ref": "#/definitions/PremierAddOn" } }, - "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}/processes/{processId}": { - "get": { + }, + "put": { "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": "Updates a named add-on of an app.", + "description": "Updates a named add-on of an app.", + "operationId": "WebApps_AddPremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6051,17 +6173,26 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", + "name": "premierAddOnName", "in": "path", - "description": "PID.", + "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" }, @@ -6071,13 +6202,16 @@ ], "responses": { "200": { - "description": "Process information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessInfo" + "$ref": "#/definitions/PremierAddOn" } }, - "404": { - "description": "Process with the specified ID is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } }, @@ -6085,9 +6219,9 @@ "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": "Delete a premier add-on from an app.", + "description": "Delete a premier add-on from an app.", + "operationId": "WebApps_DeletePremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6095,14 +6229,14 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", + "name": "premierAddOnName", "in": "path", - "description": "PID.", + "description": "Add-on name.", "required": true, "type": "string" }, @@ -6114,23 +6248,18 @@ } ], "responses": { - "204": { - "description": "Process terminated." - }, - "404": { - "description": "Process with the specified ID is not running." + "200": { + "description": "Successfully deleted premier add-on." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": { - "get": { + }, + "patch": { "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": "Updates a named add-on of an app.", + "description": "Updates a named add-on of an app.", + "operationId": "WebApps_UpdatePremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6138,17 +6267,26 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "processId", + "name": "premierAddOnName", "in": "path", - "description": "PID.", + "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" }, @@ -6160,23 +6298,26 @@ "200": { "description": "OK", "schema": { - "type": "file" + "$ref": "#/definitions/PremierAddOn" } }, - "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}/processes/{processId}/modules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { "get": { "tags": [ "WebApps" ], - "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", - "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListProcessModules", + "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" @@ -6184,14 +6325,7 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "processId", - "in": "path", - "description": "PID.", + "description": "The name of the web app.", "required": true, "type": "string" }, @@ -6204,28 +6338,26 @@ ], "responses": { "200": { - "description": "Module information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessModuleInfoCollection" + "$ref": "#/definitions/PrivateAccess" } }, - "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}/processes/{processId}/modules/{baseAddress}": { - "get": { + }, + "put": { "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": "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" @@ -6233,23 +6365,18 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "name": "processId", - "in": "path", - "description": "PID.", + "name": "access", + "in": "body", + "description": "The information for the private access", "required": true, - "type": "string" - }, - { - "name": "baseAddress", - "in": "path", - "description": "Module base address.", - "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/PrivateAccess" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6260,25 +6387,28 @@ ], "responses": { "200": { - "description": "Module information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/ProcessModuleInfo" + "$ref": "#/definitions/PrivateAccess" } }, - "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}/processes/{processId}/threads": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { "get": { "tags": [ "WebApps" ], - "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", - "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", - "operationId": "WebApps_ListProcessThreads", + "summary": "Get 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" @@ -6290,13 +6420,6 @@ "required": true, "type": "string" }, - { - "name": "processId", - "in": "path", - "description": "PID.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6306,9 +6429,9 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "Process terminated.", "schema": { - "$ref": "#/definitions/ProcessThreadInfoCollection" + "$ref": "#/definitions/ProcessInfoCollection" } }, "404": { @@ -6320,14 +6443,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": { "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_GetProcessThread", + "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" @@ -6346,13 +6469,6 @@ "required": true, "type": "string" }, - { - "name": "threadId", - "in": "path", - "description": "TID.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6362,25 +6478,23 @@ ], "responses": { "200": { - "description": "Thread information returned.", + "description": "Process information returned.", "schema": { - "$ref": "#/definitions/ProcessThreadInfo" + "$ref": "#/definitions/ProcessInfo" } }, "404": { - "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." + "description": "Process with the specified ID is not running." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { - "get": { + }, + "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": "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" @@ -6388,7 +6502,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", "required": true, "type": "string" }, @@ -6400,32 +6521,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PublicCertificateCollection" - } + "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-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": { "get": { "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": "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" @@ -6433,14 +6545,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "publicCertificateName", + "name": "processId", "in": "path", - "description": "Public certificate name.", + "description": "PID.", "required": true, "type": "string" }, @@ -6455,24 +6567,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PublicCertificate" + "type": "file" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": { + "get": { "tags": [ "WebApps" ], - "summary": "Creates a hostname binding for an app.", - "description": "Creates a hostname binding for an app.", - "operationId": "WebApps_CreateOrUpdatePublicCertificate", + "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" @@ -6480,26 +6591,17 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "publicCertificateName", + "name": "processId", "in": "path", - "description": "Public certificate name.", + "description": "PID.", "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" }, @@ -6509,26 +6611,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "#/definitions/PublicCertificate" + "$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" } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes a hostname binding for an app.", - "description": "Deletes a hostname binding for an app.", - "operationId": "WebApps_DeletePublicCertificate", + "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" @@ -6536,14 +6640,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "publicCertificateName", + "name": "processId", "in": "path", - "description": "Public certificate name.", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "baseAddress", + "in": "path", + "description": "Module base address.", "required": true, "type": "string" }, @@ -6556,25 +6667,25 @@ ], "responses": { "200": { - "description": "Successfully deleted hostname binding." + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } }, - "204": { - "description": "Hostname binding does not exist." + "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}/publishxml": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": { + "get": { "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": "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" @@ -6582,18 +6693,16 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "publishingProfileOptions", - "in": "body", - "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", + "name": "processId", + "in": "path", + "description": "PID.", "required": true, - "schema": { - "$ref": "#/definitions/CsmPublishingProfileOptions" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6604,28 +6713,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "type": "file" + "$ref": "#/definitions/ProcessThreadInfoCollection" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId}": { + "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": "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" @@ -6633,32 +6742,738 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/apiVersionParameter" - } + "name": "threadId", + "in": "path", + "description": "TID.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfo" + } + }, + "404": { + "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { + "get": { + "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", + "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/PublicCertificateCollection" + } + }, + "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}/publicCertificates/{publicCertificateName}": { + "get": { + "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", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Creates a hostname binding for an app.", + "description": "Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdatePublicCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "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" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a hostname binding for an app.", + "description": "Deletes a hostname binding for an app.", + "operationId": "WebApps_DeletePublicCertificate", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted hostname binding." + }, + "204": { + "description": "Hostname binding does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { + "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" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "publishingProfileOptions", + "in": "body", + "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmPublishingProfileOptions" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { + "post": { + "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", + "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." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restarts an app (or deployment slot, if specified).", + "description": "Restarts an app (or deployment slot, if specified).", + "operationId": "WebApps_Restart", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "softRestart", + "in": "query", + "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", + "type": "boolean" + }, + { + "name": "synchronous", + "in": "query", + "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully restarted app." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": { + "post": { + "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", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "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" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { + "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", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "restoreRequest", + "in": "body", + "description": "Deleted web app restore information.", + "required": true, + "schema": { + "$ref": "#/definitions/DeletedAppRestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a web app from a snapshot.", + "description": "Restores a web app from a snapshot.", + "operationId": "WebApps_RestoreSnapshot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "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" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { + "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", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "SiteExtension information returned.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfoCollection" + } + }, + "404": { + "description": "SiteExtension not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get site extension information by its ID for a web site, or a deployment slot.", + "description": "Get site extension information by its ID for a web site, or a deployment slot.", + "operationId": "WebApps_GetSiteExtension", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "SiteExtension information returned.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "404": { + "description": "SiteExtension with an ID of {siteExtensionId} is not running." + } + } + }, + "put": { + "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", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "200": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, + "429": { + "description": "Site Extension is being installed on another request: Rejecting current request." + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Remove a site extension from a web site, or a deployment slot.", + "description": "Remove a site extension from a web site, or a deployment slot.", + "operationId": "WebApps_DeleteSiteExtension", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "siteExtensionId", + "in": "path", + "description": "Site extension name.", + "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" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } ], "responses": { "200": { - "description": "OK." + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + } + }, + "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}": { + "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 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" @@ -6671,16 +7486,11 @@ "type": "string" }, { - "name": "softRestart", - "in": "query", - "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", - "type": "boolean" - }, - { - "name": "synchronous", - "in": "query", - "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", - "type": "boolean" + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. By default, this API returns the production slot.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -6691,19 +7501,23 @@ ], "responses": { "200": { - "description": "Successfully restarted app." + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, + "404": { + "description": "Not found." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Restores an app from a backup blob in Azure Storage.", - "description": "Restores an app from a backup blob in Azure Storage.", - "operationId": "WebApps_RestoreFromBackupBlob", + "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", + "operationId": "WebApps_CreateOrUpdateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6711,19 +7525,26 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", "required": true, "type": "string" }, { - "name": "request", + "name": "siteEnvelope", "in": "body", - "description": "Information on restore request .", + "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "./CommonDefinitions.json#/definitions/Site" } }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6732,24 +7553,34 @@ } ], "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, "202": { - "description": "Restore operation started." + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } }, - "200": { - "description": "Restore operation started." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } }, "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { - "post": { + }, + "delete": { "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": "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" @@ -6757,18 +7588,28 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app to delete.", "required": true, "type": "string" }, { - "name": "restoreRequest", - "in": "body", - "description": "Deleted web app restore information.", + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.", "required": true, - "schema": { - "$ref": "#/definitions/DeletedAppRestoreRequest" - } + "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" @@ -6778,24 +7619,24 @@ } ], "responses": { - "202": { - "description": "Restore operation started." - }, "200": { - "description": "Restore operation started." + "description": "Successfully deleted web app." + }, + "204": { + "description": "Successfully deleted web app." + }, + "404": { + "description": "Web app not found." } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": { - "post": { + } + }, + "patch": { "tags": [ "WebApps" ], - "summary": "Restores a web app from a snapshot.", - "description": "Restores a web app from a snapshot.", - "operationId": "WebApps_RestoreSnapshot", + "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" @@ -6803,19 +7644,26 @@ { "name": "name", "in": "path", - "description": "Name of web 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": "restoreRequest", + "name": "siteEnvelope", "in": "body", - "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { - "$ref": "#/definitions/SnapshotRestoreRequest" + "$ref": "#/definitions/SitePatchResource" } }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6824,24 +7672,35 @@ } ], "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } + }, "202": { - "description": "Restore operation started." + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Site" + } }, - "200": { - "description": "Restore operation started." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { "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": "Analyze a custom hostname.", + "description": "Analyze a custom hostname.", + "operationId": "WebApps_AnalyzeCustomHostnameSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6849,10 +7708,23 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, + { + "name": "hostName", + "in": "query", + "description": "Custom hostname.", + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -6862,28 +7734,28 @@ ], "responses": { "200": { - "description": "SiteExtension information returned.", + "description": "OK", "schema": { - "$ref": "#/definitions/SiteExtensionInfoCollection" + "$ref": "#/definitions/CustomHostnameAnalysisResult" } }, - "404": { - "description": "SiteExtension not found." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "post": { "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": "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" @@ -6891,14 +7763,23 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteExtensionId", + "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": "Site extension 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" }, @@ -6911,23 +7792,19 @@ ], "responses": { "200": { - "description": "SiteExtension information returned.", - "schema": { - "$ref": "#/definitions/SiteExtensionInfo" - } - }, - "404": { - "description": "SiteExtension with an ID of {siteExtensionId} is not running." + "description": "OK." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { + "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": "Creates a backup of an app.", + "description": "Creates a backup of an app.", + "operationId": "WebApps_BackupSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6935,14 +7812,23 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteExtensionId", + "name": "request", + "in": "body", + "description": "Backup configuration. You can use the JSON response from the POST action as input here.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", "in": "path", - "description": "Site extension name.", + "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" }, @@ -6954,31 +7840,29 @@ } ], "responses": { - "201": { - "description": "Site Extension created.", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/SiteExtensionInfo" + "$ref": "#/definitions/BackupItem" } }, - "200": { - "description": "Site Extension created.", + "default": { + "description": "App Service error response.", "schema": { - "$ref": "#/definitions/SiteExtensionInfo" + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } - }, - "429": { - "description": "Site Extension is being installed on another request: Rejecting current request." } - }, - "x-ms-long-running-operation": true - }, - "delete": { + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { + "get": { "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": "Gets existing backups of an app.", + "description": "Gets existing backups of an app.", + "operationId": "WebApps_ListBackupsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6986,14 +7870,14 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteExtensionId", + "name": "slot", "in": "path", - "description": "Site extension name.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.", "required": true, "type": "string" }, @@ -7005,23 +7889,32 @@ } ], "responses": { - "204": { - "description": "SiteExtension terminated." + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItemCollection" + } }, - "404": { - "description": "SiteExtension with an ID of {siteExtensionId} is not running." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets an app's deployment slots.", - "description": "Gets an app's deployment slots.", - "operationId": "WebApps_ListSlots", + "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" @@ -7033,6 +7926,20 @@ "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.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7044,7 +7951,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection" + "$ref": "#/definitions/BackupItem" } }, "default": { @@ -7053,20 +7960,15 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": { - "get": { + }, + "delete": { "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": "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" @@ -7078,10 +7980,17 @@ "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. By default, this API returns the production slot.", + "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" }, @@ -7094,23 +8003,22 @@ ], "responses": { "200": { - "description": "OK.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" - } + "description": "Successfully deleted web app backup item." }, "404": { - "description": "Not found." + "description": "Web app backup item does not exist." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", - "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", - "operationId": "WebApps_CreateOrUpdateSlot", + "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" @@ -7118,23 +8026,30 @@ { "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 web app.", "required": true, "type": "string" }, { - "name": "siteEnvelope", + "name": "backupId", + "in": "path", + "description": "ID of backup.", + "required": true, + "type": "string" + }, + { + "name": "request", "in": "body", - "description": "A JSON representation of the app properties. See example.", + "description": "Information on backup request.", "required": true, "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" + "$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 web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -7147,15 +8062,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/BackupItem" } }, "default": { @@ -7164,16 +8073,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-long-running-operation": true - }, - "delete": { + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { + "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": "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" @@ -7181,28 +8091,32 @@ { "name": "name", "in": "path", - "description": "Name of the app to delete.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "slot", + "name": "backupId", "in": "path", - "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.", + "description": "ID of the backup.", "required": true, "type": "string" }, { - "name": "deleteMetrics", - "in": "query", - "description": "If true, web app metrics are also deleted.", - "type": "boolean" + "name": "request", + "in": "body", + "description": "Information on restore request .", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } }, { - "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" + "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" @@ -7212,24 +8126,24 @@ } ], "responses": { - "200": { - "description": "Successfully deleted web app." - }, - "204": { - "description": "Successfully deleted web app." + "202": { + "description": "Restore operation started." }, - "404": { - "description": "Web app not found." + "200": { + "description": "Restore operation started." } - } - }, - "patch": { + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": { + "get": { "tags": [ "WebApps" ], - "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", - "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", - "operationId": "WebApps_UpdateSlot", + "summary": "List the configurations of an app", + "description": "List the configurations of an app", + "operationId": "WebApps_ListConfigurationsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7237,23 +8151,14 @@ { "name": "name", "in": "path", - "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", + "description": "Name of the app.", "required": true, "type": "string" }, - { - "name": "siteEnvelope", - "in": "body", - "description": "A JSON representation of the app properties. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/SitePatchResource" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -7266,15 +8171,9 @@ ], "responses": { "200": { - "description": "OK.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" - } - }, - "202": { - "description": "Asynchronous operation in progress.", + "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Site" + "$ref": "#/definitions/SiteConfigResourceCollection" } }, "default": { @@ -7283,17 +8182,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { + "put": { "tags": [ "WebApps" ], - "summary": "Analyze a custom hostname.", - "description": "Analyze a custom hostname.", - "operationId": "WebApps_AnalyzeCustomHostnameSlot", + "summary": "Replaces the application settings of an app.", + "description": "Replaces the application settings of an app.", + "operationId": "WebApps_UpdateApplicationSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7301,21 +8203,24 @@ { "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.", + "name": "appSettings", + "in": "body", + "description": "Application settings of the app.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/StringDictionary" + } }, { - "name": "hostName", - "in": "query", - "description": "Custom hostname.", + "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.", + "required": true, "type": "string" }, { @@ -7329,7 +8234,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CustomHostnameAnalysisResult" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -7341,14 +8246,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/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 application settings of an app.", + "description": "Gets the application settings of an app.", + "operationId": "WebApps_ListApplicationSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7360,19 +8265,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 application settings for the production slot.", "required": true, "type": "string" }, @@ -7385,19 +8281,28 @@ ], "responses": { "200": { - "description": "OK." + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, + "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/authsettings": { + "put": { "tags": [ "WebApps" ], - "summary": "Creates a backup of an app.", - "description": "Creates a backup of an app.", - "operationId": "WebApps_BackupSlot", + "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" @@ -7405,23 +8310,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "request", + "name": "siteAuthSettings", "in": "body", - "description": "Backup configuration. You can use the JSON response from the POST action as input here.", + "description": "Auth settings associated with web app.", "required": true, "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteAuthSettings" } }, { "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 web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -7436,7 +8341,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/SiteAuthSettings" } }, "default": { @@ -7448,14 +8353,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/authsettings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets existing backups of an app.", - "description": "Gets existing backups of an app.", - "operationId": "WebApps_ListBackupsSlot", + "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" @@ -7470,7 +8375,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 settings for the production slot.", "required": true, "type": "string" }, @@ -7485,7 +8390,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItemCollection" + "$ref": "#/definitions/SiteAuthSettings" } }, "default": { @@ -7494,20 +8399,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": { + "put": { "tags": [ "WebApps" ], - "summary": "Gets a backup of an app by its ID.", - "description": "Gets a backup of an app by its ID.", - "operationId": "WebApps_GetBackupStatusSlot", + "summary": "Updates the Azure storage account configurations of an app.", + "description": "Updates the Azure storage account configurations of an app.", + "operationId": "WebApps_UpdateAzureStorageAccountsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7520,16 +8422,18 @@ "type": "string" }, { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", + "name": "azureStorageAccounts", + "in": "body", + "description": "Azure storage accounts of the app.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", "required": true, "type": "string" }, @@ -7544,7 +8448,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, "default": { @@ -7554,14 +8458,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": { + "post": { "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": "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" @@ -7573,17 +8479,10 @@ "required": true, "type": "string" }, - { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", - "required": true, - "type": "string" - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", "required": true, "type": "string" }, @@ -7596,22 +8495,28 @@ ], "responses": { "200": { - "description": "Successfully deleted web app backup item." + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + } }, - "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/backup": { + "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": "Updates the backup configuration of an app.", + "description": "Updates the backup configuration of an app.", + "operationId": "WebApps_UpdateBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7619,21 +8524,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "ID of backup.", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", - "description": "Information on backup request.", + "description": "Edited backup configuration.", "required": true, "schema": { "$ref": "#/definitions/BackupRequest" @@ -7642,7 +8540,7 @@ { "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 backup configuration for the production slot.", "required": true, "type": "string" }, @@ -7657,7 +8555,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/BackupRequest" } }, "default": { @@ -7667,16 +8565,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { - "post": { + }, + "delete": { "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": "Deletes the backup configuration of an app.", + "description": "Deletes the backup configuration of an app.", + "operationId": "WebApps_DeleteBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7689,25 +8585,49 @@ "type": "string" }, { - "name": "backupId", + "name": "slot", "in": "path", - "description": "ID of the backup.", + "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": "request", - "in": "body", - "description": "Information on restore request .", + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted backup configuration." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Gets the backup configuration of an app.", + "description": "Gets the backup configuration of an app.", + "operationId": "WebApps_GetBackupConfigurationSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", "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 restore a backup of the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.", "required": true, "type": "string" }, @@ -7719,24 +8639,29 @@ } ], "responses": { - "202": { - "description": "Restore operation started." - }, "200": { - "description": "Restore operation started." + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { + "put": { "tags": [ "WebApps" ], - "summary": "List the configurations of an app", - "description": "List the configurations of an app", - "operationId": "WebApps_ListConfigurationsSlot", + "summary": "Replaces the connection strings of an app.", + "description": "Replaces the connection strings of an app.", + "operationId": "WebApps_UpdateConnectionStringsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7748,10 +8673,19 @@ "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 return configuration 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" }, @@ -7766,7 +8700,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResourceCollection" + "$ref": "#/definitions/ConnectionStringDictionary" } }, "default": { @@ -7775,20 +8709,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Replaces the application settings of an app.", - "description": "Replaces the application settings of an app.", - "operationId": "WebApps_UpdateApplicationSettingsSlot", + "summary": "Gets the connection strings of an app.", + "description": "Gets the connection strings of an app.", + "operationId": "WebApps_ListConnectionStringsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7800,19 +8731,10 @@ "required": true, "type": "string" }, - { - "name": "appSettings", - "in": "body", - "description": "Application settings of the app.", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.", "required": true, "type": "string" }, @@ -7827,7 +8749,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/ConnectionStringDictionary" } }, "default": { @@ -7839,14 +8761,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { + "get": { "tags": [ "WebApps" ], - "summary": "Gets the application settings of an app.", - "description": "Gets the application settings of an app.", - "operationId": "WebApps_ListApplicationSettingsSlot", + "summary": "Gets the logging configuration of an app.", + "description": "Gets the logging configuration of an app.", + "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7861,7 +8783,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.", "required": true, "type": "string" }, @@ -7876,7 +8798,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteLogsConfig" } }, "default": { @@ -7886,16 +8808,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { + }, "put": { "tags": [ "WebApps" ], - "summary": "Updates the Authentication / Authorization settings associated with web app.", - "description": "Updates the Authentication / Authorization settings associated with web app.", - "operationId": "WebApps_UpdateAuthSettingsSlot", + "summary": "Updates the logging configuration of an app.", + "description": "Updates the logging configuration of an app.", + "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7903,23 +8823,23 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteAuthSettings", + "name": "siteLogsConfig", "in": "body", - "description": "Auth settings associated with web app.", + "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", "required": true, "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/SiteLogsConfig" } }, { "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 logging configuration for the production slot.", "required": true, "type": "string" }, @@ -7934,7 +8854,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/SiteLogsConfig" } }, "default": { @@ -7946,14 +8866,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { + "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": "Replaces the metadata of an app.", + "description": "Replaces the metadata of an app.", + "operationId": "WebApps_UpdateMetadataSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7965,10 +8885,19 @@ "required": true, "type": "string" }, + { + "name": "metadata", + "in": "body", + "description": "Edited metadata of the app or deployment slot. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the 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" }, @@ -7983,7 +8912,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -7995,14 +8924,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates the Azure storage account configurations of an app.", - "description": "Updates the Azure storage account configurations of an app.", - "operationId": "WebApps_UpdateAzureStorageAccountsSlot", + "summary": "Gets the metadata of an app.", + "description": "Gets the metadata of an app.", + "operationId": "WebApps_ListMetadataSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8014,19 +8943,10 @@ "required": true, "type": "string" }, - { - "name": "azureStorageAccounts", - "in": "body", - "description": "Azure storage accounts of the app.", - "required": true, - "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.", "required": true, "type": "string" }, @@ -8041,7 +8961,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + "$ref": "#/definitions/StringDictionary" } }, "default": { @@ -8053,14 +8973,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { "post": { "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 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" @@ -8075,7 +8995,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 get the publishing credentials for the production slot.", "required": true, "type": "string" }, @@ -8090,7 +9010,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" + "$ref": "./CommonDefinitions.json#/definitions/User" } }, "default": { @@ -8099,17 +9019,18 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { "put": { "tags": [ "WebApps" ], - "summary": "Updates the backup configuration of an app.", - "description": "Updates the backup configuration of an app.", - "operationId": "WebApps_UpdateBackupConfigurationSlot", + "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" @@ -8117,23 +9038,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "request", + "name": "pushSettings", "in": "body", - "description": "Edited backup configuration.", + "description": "Push settings associated with web app.", "required": true, "schema": { - "$ref": "#/definitions/BackupRequest" + "$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 backup configuration for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8148,7 +9069,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" } }, "default": { @@ -8158,14 +9079,16 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Deletes the backup configuration of an app.", - "description": "Deletes the backup configuration of an app.", - "operationId": "WebApps_DeleteBackupConfigurationSlot", + "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" @@ -8173,14 +9096,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 delete 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" }, @@ -8193,19 +9116,28 @@ ], "responses": { "200": { - "description": "Successfully deleted backup configuration." + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { + "get": { "tags": [ "WebApps" ], - "summary": "Gets the backup configuration of an app.", - "description": "Gets the backup configuration of an app.", - "operationId": "WebApps_GetBackupConfigurationSlot", + "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" @@ -8220,7 +9152,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8235,7 +9167,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8245,16 +9177,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { + }, "put": { "tags": [ "WebApps" ], - "summary": "Replaces the connection strings of an app.", - "description": "Replaces the connection strings of an app.", - "operationId": "WebApps_UpdateConnectionStringsSlot", + "summary": "Updates the configuration of an app.", + "description": "Updates the configuration of an app.", + "operationId": "WebApps_CreateOrUpdateConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8267,18 +9197,18 @@ "type": "string" }, { - "name": "connectionStrings", + "name": "siteConfig", "in": "body", - "description": "Connection strings of the app or deployment slot. See example.", + "description": "JSON representation of a SiteConfig object. See example.", "required": true, "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteConfigResource" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", "required": true, "type": "string" }, @@ -8293,7 +9223,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8303,16 +9233,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { - "post": { + }, + "patch": { "tags": [ "WebApps" ], - "summary": "Gets the connection strings of an app.", - "description": "Gets the connection strings of an app.", - "operationId": "WebApps_ListConnectionStringsSlot", + "summary": "Updates the configuration of an app.", + "description": "Updates the configuration of an app.", + "operationId": "WebApps_UpdateConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8324,10 +9252,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 connection settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", "required": true, "type": "string" }, @@ -8342,7 +9279,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8354,14 +9291,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": { "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 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" @@ -8376,7 +9313,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8391,7 +9328,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection" } }, "default": { @@ -8400,15 +9337,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates the logging configuration of an app.", - "description": "Updates the logging configuration of an app.", - "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", + "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" @@ -8421,18 +9363,16 @@ "type": "string" }, { - "name": "siteLogsConfig", - "in": "body", - "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", "required": true, - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8447,7 +9387,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/SiteConfigResource" } }, "default": { @@ -8459,14 +9399,14 @@ } } }, - "/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}/config/web/snapshots/{snapshotId}/recover": { + "post": { "tags": [ "WebApps" ], - "summary": "Replaces the metadata of an app.", - "description": "Replaces the metadata of an app.", - "operationId": "WebApps_UpdateMetadataSlot", + "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" @@ -8479,18 +9419,16 @@ "type": "string" }, { - "name": "metadata", - "in": "body", - "description": "Edited metadata of the app or deployment slot. See example.", + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", "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 will return configuration for the production slot.", "required": true, "type": "string" }, @@ -8502,29 +9440,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "No Content" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the metadata of an app.", - "description": "Gets the metadata of an app.", - "operationId": "WebApps_ListMetadataSlot", + "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" @@ -8532,14 +9464,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8551,29 +9483,29 @@ } ], "responses": { + "204": { + "description": "No Content" + }, "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + "type": "file" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": { "post": { "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": "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" @@ -8581,14 +9513,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 publishing credentials for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8600,30 +9532,26 @@ } ], "responses": { + "204": { + "description": "No Content" + }, "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/User" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + "type": "file" } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { + "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": "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" @@ -8631,23 +9559,14 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, - { - "name": "pushSettings", - "in": "body", - "description": "Push settings associated with web app.", - "required": true, - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PushSettings" - } - }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8662,7 +9581,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + "$ref": "#/definitions/ContinuousWebJobCollection" } }, "default": { @@ -8671,17 +9590,20 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Gets the Push settings associated with web app.", - "description": "Gets the Push settings associated with web app.", - "operationId": "WebApps_ListSitePushSettingsSlot", + "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" @@ -8689,14 +9611,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8709,28 +9638,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Found continuous web job.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/PushSettings" + "$ref": "#/definitions/ContinuousWebJob" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Continuous web job does not exist." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/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 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" @@ -8738,14 +9662,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8758,26 +9689,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "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." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": { + "post": { "tags": [ - "WebApps" - ], - "summary": "Updates the configuration of an app.", - "description": "Updates the configuration of an app.", - "operationId": "WebApps_CreateOrUpdateConfigurationSlot", + "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8785,23 +9712,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "siteConfig", - "in": "body", - "description": "JSON representation of a SiteConfig object. See example.", + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8814,26 +9739,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "description": "Found continuous web job." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Continuous web job does not exist." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates the configuration of an app.", - "description": "Updates the configuration of an app.", - "operationId": "WebApps_UpdateConfigurationSlot", + "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" @@ -8841,23 +9762,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "siteConfig", - "in": "body", - "description": "JSON representation of a SiteConfig object. See example.", + "name": "webJobName", + "in": "path", + "description": "Name of Web Job.", "required": true, - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8870,28 +9789,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } + "description": "Found continuous web job." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Continuous web job does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { "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": "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" @@ -8906,7 +9819,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 returns deployments for the production slot.", "required": true, "type": "string" }, @@ -8921,7 +9834,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection" + "$ref": "#/definitions/DeploymentCollection" } }, "default": { @@ -8936,14 +9849,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}/deployments/{id}": { "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 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" @@ -8956,16 +9869,16 @@ "type": "string" }, { - "name": "snapshotId", + "name": "id", "in": "path", - "description": "The ID of the snapshot to read.", + "description": "Deployment ID.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.", "required": true, "type": "string" }, @@ -8980,7 +9893,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/Deployment" } }, "default": { @@ -8990,16 +9903,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": "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" @@ -9012,61 +9923,27 @@ "type": "string" }, { - "name": "snapshotId", + "name": "id", "in": "path", - "description": "The ID of the snapshot to read.", + "description": "ID of an existing deployment.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "204": { - "description": "No Content" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": { - "post": { - "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" - ], - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app.", + "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": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "name": "deployment", + "in": "body", + "description": "Deployment details.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/Deployment" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -9076,29 +9953,27 @@ } ], "responses": { - "204": { - "description": "No Content" - }, "200": { "description": "OK", "schema": { - "type": "file" + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": { - "post": { + }, + "delete": { "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": "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" @@ -9106,14 +9981,21 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Deployment ID.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -9125,26 +10007,23 @@ } ], "responses": { - "204": { - "description": "No Content" - }, "200": { - "description": "OK", - "schema": { - "type": "file" - } + "description": "Successfully deleted deployment." + }, + "204": { + "description": "Deployment does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": { "get": { "tags": [ "WebApps" ], - "summary": "List continuous web jobs for an app, or a deployment slot.", - "description": "List continuous web jobs for an app, or a deployment slot.", - "operationId": "WebApps_ListContinuousWebJobsSlot", + "summary": "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" @@ -9152,14 +10031,21 @@ { "name": "name", "in": "path", - "description": "Site name.", + "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 deletes a deployment 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" }, @@ -9174,7 +10060,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ContinuousWebJobCollection" + "$ref": "#/definitions/Deployment" } }, "default": { @@ -9183,20 +10069,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": { + "post": { "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": "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" @@ -9204,21 +10087,23 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "webJobName", - "in": "path", - "description": "Name of Web Job.", + "name": "request", + "in": "body", + "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/RestoreRequest" + } }, { "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 perform discovery for the production slot.", "required": true, "type": "string" }, @@ -9231,23 +10116,28 @@ ], "responses": { "200": { - "description": "Found continuous web job.", + "description": "OK", "schema": { - "$ref": "#/definitions/ContinuousWebJob" + "$ref": "#/definitions/RestoreRequest" } }, - "404": { - "description": "Continuous web job does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { + "get": { "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": "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" @@ -9255,21 +10145,14 @@ { "name": "name", "in": "path", - "description": "Site name.", - "required": true, - "type": "string" - }, - { - "name": "webJobName", - "in": "path", - "description": "Name of Web Job.", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9282,22 +10165,31 @@ ], "responses": { "200": { - "description": "Successfully deleted continuous web job." + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection" + } }, - "204": { - "description": "Continuous web job does not exist." + "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}/continuouswebjobs/{webJobName}/start": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { + "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 domain ownership identifier for web app.", + "description": "Get domain ownership identifier for web app.", + "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9305,21 +10197,21 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "webJobName", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "Name of Web Job.", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9332,22 +10224,26 @@ ], "responses": { "200": { - "description": "Found continuous web job." + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } }, - "404": { - "description": "Continuous web job does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Stop a continuous web job for an app, or a deployment slot.", - "description": "Stop a continuous web job for an app, or a deployment slot.", - "operationId": "WebApps_StopContinuousWebJobSlot", + "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "description": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", + "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9355,21 +10251,30 @@ { "name": "name", "in": "path", - "description": "Site name.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "webJobName", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "Name of Web Job.", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, @@ -9382,22 +10287,26 @@ ], "responses": { "200": { - "description": "Found continuous web job." + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Identifier" + } }, - "404": { - "description": "Continuous web job does not exist." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { - "get": { + }, + "delete": { "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": "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" @@ -9409,10 +10318,17 @@ "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 the deployment slot. If a slot is not specified, the API returns deployments 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" }, @@ -9425,31 +10341,20 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeploymentCollection" - } + "description": "Successfully deleted domain ownership identifier." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Domain ownership identifier does not exist." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { - "get": { + }, + "patch": { "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": "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" @@ -9462,16 +10367,25 @@ "type": "string" }, { - "name": "id", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "Deployment ID.", + "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 gets 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" }, @@ -9486,7 +10400,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "./CommonDefinitions.json#/definitions/Identifier" } }, "default": { @@ -9496,14 +10410,16 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { + "get": { "tags": [ "WebApps" ], - "summary": "Create a deployment for an app, or a deployment slot.", - "description": "Create a deployment for an app, or a deployment slot.", - "operationId": "WebApps_CreateDeploymentSlot", + "summary": "Get the status of the last MSDeploy operation.", + "description": "Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9511,33 +10427,17 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "ID of an existing deployment.", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, - { - "name": "deployment", - "in": "body", - "description": "Deployment details.", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -9549,7 +10449,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/MSDeployStatus" } }, "default": { @@ -9560,13 +10460,13 @@ } } }, - "delete": { + "put": { "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": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateMSDeployOperationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9574,23 +10474,25 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "id", + "name": "slot", "in": "path", - "description": "Deployment ID.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API 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" @@ -9600,23 +10502,27 @@ } ], "responses": { - "200": { - "description": "Successfully deleted deployment." + "201": { + "description": "Deployment is scheduled.", + "schema": { + "$ref": "#/definitions/MSDeployStatus" + } }, - "204": { - "description": "Deployment 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}/deployments/{id}/log": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/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", + "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" @@ -9624,21 +10530,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -9651,28 +10550,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "MSDeploy log returned.", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/MSDeployLog" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "MSDeploy log not found." } } } }, - "/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": { + "get": { "tags": [ "WebApps" ], - "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", - "description": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", - "operationId": "WebApps_DiscoverBackupSlot", + "summary": "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" @@ -9680,23 +10576,14 @@ { "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.", - "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 perform discovery for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -9709,28 +10596,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function information returned.", "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/FunctionEnvelopeCollection" } }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "404": { + "description": "Function with an ID of {functionName} is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": { "get": { "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": "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" @@ -9738,14 +10625,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 delete the binding for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -9760,7 +10647,7 @@ "200": { "description": "OK", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection" + "type": "string" } }, "default": { @@ -9769,20 +10656,17 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": { "get": { "tags": [ "WebApps" ], - "summary": "Get domain ownership identifier for web app.", - "description": "Get domain ownership identifier for web app.", - "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", + "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" @@ -9790,21 +10674,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,16 +10701,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function information returned.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" + "$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." } } }, @@ -9834,9 +10715,9 @@ "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": "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" @@ -9844,33 +10725,33 @@ { "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" }, + { + "name": "function_envelope", + "in": "body", + "description": "Function details.", + "required": true, + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -9879,10 +10760,10 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Function created.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" + "$ref": "#/definitions/FunctionEnvelope" } }, "default": { @@ -9891,15 +10772,16 @@ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } - } + }, + "x-ms-long-running-operation": true }, "delete": { "tags": [ "WebApps" ], - "summary": "Deletes a domain ownership identifier for a web app.", - "description": "Deletes a domain ownership identifier for a web app.", - "operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot", + "summary": "Delete a function 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" @@ -9907,21 +10789,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" }, @@ -9933,21 +10815,23 @@ } ], "responses": { - "200": { - "description": "Successfully deleted domain ownership identifier." - }, "204": { - "description": "Domain ownership identifier does not exist." + "description": "Function deleted." + }, + "404": { + "description": "Function does not exist." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}": { + "put": { "tags": [ "WebApps" ], - "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", - "description": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", - "operationId": "WebApps_UpdateDomainOwnershipIdentifierSlot", + "summary": "Add or update a function secret.", + "description": "Add or update a function secret.", + "operationId": "WebApps_CreateOrUpdateFunctionSecretSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9955,33 +10839,40 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "domainOwnershipIdentifierName", + "name": "functionName", "in": "path", - "description": "Name of domain ownership identifier.", + "description": "The name of the function.", "required": true, "type": "string" }, { - "name": "domainOwnershipIdentifier", - "in": "body", - "description": "A JSON representation of the domain ownership properties.", + "name": "keyName", + "in": "path", + "description": "The name of the key.", "required": true, - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" - } + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, + { + "name": "key", + "in": "body", + "description": "The key to create or update", + "required": true, + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -9990,10 +10881,16 @@ } ], "responses": { + "201": { + "description": "Key was created.", + "schema": { + "$ref": "#/definitions/KeyInfo" + } + }, "200": { - "description": "OK", + "description": "Key was updated.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Identifier" + "$ref": "#/definitions/KeyInfo" } }, "default": { @@ -10003,16 +10900,14 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_GetMSDeployStatusSlot", + "summary": "Delete a function secret.", + "description": "Delete a function secret.", + "operationId": "WebApps_DeleteFunctionSecretSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10020,14 +10915,28 @@ { "name": "name", "in": "path", - "description": "Name of web 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 web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -10039,27 +10948,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MSDeployStatus" - } + "404": { + "description": "Key was not found." }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "204": { + "description": "Key was deleted." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension.", - "description": "Invoke the MSDeploy web app extension.", - "operationId": "WebApps_CreateMSDeployOperationSlot", + "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" @@ -10067,25 +10972,23 @@ { "name": "name", "in": "path", - "description": "Name of web app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "slot", + "name": "functionName", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Function name.", "required": true, "type": "string" }, { - "name": "MSDeploy", - "in": "body", - "description": "Details of MSDeploy operation", + "name": "slot", + "in": "path", + "description": "Name of the deployment slot.", "required": true, - "schema": { - "$ref": "#/definitions/MSDeploy" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -10095,27 +10998,29 @@ } ], "responses": { - "201": { - "description": "Deployment is scheduled.", + "200": { + "description": "Function keys returned.", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/StringDictionary" } }, - "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}/functions/{functionName}/listsecrets": { + "post": { "tags": [ "WebApps" ], - "summary": "Get the MSDeploy Log for the last MSDeploy operation.", - "description": "Get the MSDeploy Log for the last MSDeploy operation.", - "operationId": "WebApps_GetMSDeployLogSlot", + "summary": "Get 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" @@ -10123,14 +11028,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" }, @@ -10143,25 +11055,28 @@ ], "responses": { "200": { - "description": "MSDeploy log returned.", + "description": "Function secrets returned.", "schema": { - "$ref": "#/definitions/MSDeployLog" + "$ref": "#/definitions/FunctionSecrets" } }, - "404": { - "description": "MSDeploy log not found." + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys": { + "post": { "tags": [ "WebApps" ], - "summary": "List the functions for a web site, or a deployment slot.", - "description": "List the functions for a web site, or a deployment slot.", - "operationId": "WebApps_ListInstanceFunctionsSlot", + "summary": "Get host secrets for a function app.", + "description": "Get host secrets for a function app.", + "operationId": "WebApps_ListHostKeysSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10176,7 +11091,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 +11104,28 @@ ], "responses": { "200": { - "description": "Function information returned.", + "description": "Host secrets returned.", "schema": { - "$ref": "#/definitions/FunctionEnvelopeCollection" + "$ref": "#/definitions/HostKeys" } }, - "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": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus": { + "post": { "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": "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" @@ -10218,14 +11133,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" }, @@ -10237,11 +11152,8 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } + "204": { + "description": "No Content" }, "default": { "description": "App Service error response.", @@ -10252,14 +11164,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 +11179,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 +11198,26 @@ } ], "responses": { - "200": { - "description": "Function information returned.", + "204": { + "description": "No Content" + }, + "default": { + "description": "App Service error response.", "schema": { - "$ref": "#/definitions/FunctionEnvelope" + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } - }, - "404": { - "description": "Function with an name of {functionName} is not running." } } - }, + } + }, + "/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 +11230,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 +11268,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 +11285,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 +11306,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,11 +11334,11 @@ } ], "responses": { - "200": { - "description": "Function secrets returned.", - "schema": { - "$ref": "#/definitions/FunctionSecrets" - } + "404": { + "description": "Key was not found." + }, + "204": { + "description": "Key was deleted." }, "default": { "description": "App Service error response.", @@ -12125,7 +13001,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 +16353,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 +16370,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 +17985,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 +19693,7 @@ } }, "FunctionEnvelope": { - "description": "Web Job Information.", + "description": "Function information.", "type": "object", "allOf": [ { @@ -18844,6 +19720,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 +19746,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 +19810,30 @@ } } }, + "HostKeys": { + "description": "Functions host level keys.", + "type": "object", + "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" + } + } + } + }, "HostNameBinding": { "description": "A hostname binding object.", "type": "object", @@ -19072,6 +19988,20 @@ } } }, + "KeyInfo": { + "description": "Function key info.", + "type": "object", + "properties": { + "name": { + "description": "Key name", + "type": "string" + }, + "value": { + "description": "Key value", + "type": "string" + } + } + }, "MSDeploy": { "description": "MSDeploy ARM PUT information", "type": "object", @@ -20925,7 +21855,7 @@ "items": { "$ref": "./CommonDefinitions.json#/definitions/GeoDistribution" } - } + } }, "x-ms-client-flatten": true }, @@ -21686,4 +22616,4 @@ ] } ] -} +} \ No newline at end of file