diff --git a/specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json index 5d7214eeaae3..523fd86ba9d1 100644 --- a/specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json @@ -166,7 +166,7 @@ { "name": "skipDnsRegistration", "in": "query", - "description": "If true web app hostname is not registered with DNS on creation. This parameter is\n only used for app creation", + "description": "If true web app hostname is not registered with DNS on creation. This parameter is\n only used for app creation.", "type": "boolean" }, { @@ -178,13 +178,13 @@ { "name": "forceDnsRegistration", "in": "query", - "description": "If true, web app hostname is force registered with DNS", + "description": "If true, web app hostname is force registered with DNS.", "type": "boolean" }, { "name": "ttlInSeconds", "in": "query", - "description": "Time to live in seconds for web app's default domain name", + "description": "Time to live in seconds for web app's default domain name.", "type": "string" }, { @@ -196,13 +196,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { "$ref": "#/definitions/Site" } }, "202": { - "description": "Asynchronous operation in progress", + "description": "Asynchronous operation in progress.", "schema": { "$ref": "#/definitions/Site" } @@ -231,7 +231,7 @@ { "name": "deleteMetrics", "in": "query", - "description": "If true, web app metrics are also deleted", + "description": "If true, web app metrics are also deleted.", "type": "boolean" }, { @@ -243,7 +243,7 @@ { "name": "skipDnsRegistration", "in": "query", - "description": "If true, DNS registration is skipped", + "description": "If true, DNS registration is skipped.", "type": "boolean" }, { @@ -255,10 +255,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted web app" + "description": "Succesfully deleted web app." }, "404": { - "description": "Web app not found" + "description": "Web app not found." } } } @@ -284,14 +284,14 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "hostName", "in": "query", - "description": "Custom hostname", + "description": "Custom hostname.", "type": "string" }, { @@ -355,7 +355,7 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK." } } } @@ -631,21 +631,21 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "backupId", "in": "path", - "description": "Id of backup", + "description": "ID of backup.", "required": true, "type": "string" }, { "name": "request", "in": "body", - "description": "Information on backup request", + "description": "Information on backup request.", "required": true, "schema": { "$ref": "#/definitions/BackupRequest" @@ -708,7 +708,7 @@ { "name": "request", "in": "body", - "description": "Information on restore request", + "description": "Information on restore request .", "required": true, "schema": { "$ref": "#/definitions/RestoreRequest" @@ -899,14 +899,14 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "siteAuthSettings", "in": "body", - "description": "Auth settings associated with web app", + "description": "Auth settings associated with web app.", "required": true, "schema": { "$ref": "#/definitions/SiteAuthSettings" @@ -1461,14 +1461,14 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "pushSettings", "in": "body", - "description": "Push settings associated with web app", + "description": "Push settings associated with web app.", "required": true, "schema": { "$ref": "#/definitions/PushSettings" @@ -1512,7 +1512,7 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -1913,13 +1913,259 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List continuous web jobs for an app, or a deployment slot.", + "description": "List continuous web jobs for an app, or a deployment slot.", + "operationId": "WebApps_ListContinuousWebJobs", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContinuousWebJobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a continuous web job by its ID for an app, or a deployment slot.", + "description": "Gets a continuous web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetContinuousWebJob", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/ContinuousWebJob" + } + }, + "404": { + "description": "Continuous web job does not exist." + } + } + }, + "delete": { + "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_DeleteContinuousWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted continuous web job." + }, + "204": { + "description": "Continuous web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start": { + "post": { + "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_StartContinuousWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Continuous web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop": { + "post": { + "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_StopContinuousWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Continuous web job does not exist." + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": { "get": { "tags": [ "WebApps" ], - "summary": "List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.", - "description": "List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.", + "summary": "List deployments for an app, or a deployment slot.", + "description": "List deployments for an app, or a deployment slot.", "operationId": "WebApps_ListDeployments", "produces": [ "application/json", @@ -1961,8 +2207,8 @@ "tags": [ "WebApps" ], - "summary": "Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", + "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_GetDeployment", "produces": [ "application/json", @@ -2008,8 +2254,8 @@ "tags": [ "WebApps" ], - "summary": "Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.", + "summary": "Create a deployment for an app, or a deployment slot.", + "description": "Create a deployment for an app, or a deployment slot.", "operationId": "WebApps_CreateDeployment", "consumes": [ "application/json", @@ -2069,8 +2315,8 @@ "tags": [ "WebApps" ], - "summary": "Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", + "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_DeleteDeployment", "parameters": [ { @@ -2099,10 +2345,59 @@ ], "responses": { "200": { - "description": "Succesfully deleted deployment" + "description": "Succesfully deleted deployment." }, "204": { - "description": "Deployment does not exist" + "description": "Deployment does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List deployment log for specific deployment for an app, or a deployment slot.", + "description": "List deployment log for specific deployment for an app, or a deployment slot.", + "operationId": "WebApps_ListDeploymentLog", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } } } } @@ -2367,8 +2662,8 @@ "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension as pass-through API", - "description": "Invoke the MSDeploy web app extension as pass-through API", + "summary": "Get the status of the last MSDeploy operation.", + "description": "Get the status of the last MSDeploy operation.", "operationId": "WebApps_GetMSDeployStatus", "produces": [ "application/json", @@ -2383,7 +2678,7 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -2407,8 +2702,8 @@ "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension as pass-through API", - "description": "Invoke the MSDeploy web app extension as pass-through API", + "summary": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", "operationId": "WebApps_CreateMSDeployOperation", "consumes": [ "application/json", @@ -2428,7 +2723,7 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -2450,13 +2745,13 @@ ], "responses": { "201": { - "description": "Deployment is scheduled", + "description": "Deployment is scheduled.", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "409": { - "description": "Another deployment is in progress" + "description": "Another deployment is in progress." } }, "x-ms-long-running-operation": true @@ -2467,8 +2762,8 @@ "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy Log web app extension as pass-through API", - "description": "Invoke the MSDeploy Log web app extension as pass-through API", + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Get the MSDeploy Log for the last MSDeploy operation.", "operationId": "WebApps_GetMSDeployLog", "produces": [ "application/json", @@ -2483,7 +2778,7 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -2496,27 +2791,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "MSDeploy log returned.", "schema": { "$ref": "#/definitions/MSDeployLog" } + }, + "404": { + "description": "MSDeploy log not found." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions": { "get": { "tags": [ "WebApps" ], - "summary": "Fetch a short lived token that can be exchanged for a master key.", - "description": "Fetch a short lived token that can be exchanged for a master key.", - "operationId": "WebApps_GetFunctionsAdminToken", + "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_ListFunctions", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2525,7 +2821,55 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelopeCollection" + } + }, + "404": { + "description": "Function with an ID of {functionName} is not running." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Fetch a short lived token that can be exchanged for a master key.", + "description": "Fetch a short lived token that can be exchanged for a master key.", + "operationId": "WebApps_GetFunctionsAdminToken", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -2546,6 +2890,210 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}": { + "get": { + "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_GetFunction", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + "404": { + "description": "Function with an name of {functionName} is not running." + } + } + }, + "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_CreateFunction", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "name": "function_envelope", + "in": "body", + "description": "Function details.", + "required": true, + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Function created.", + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + } + }, + "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_DeleteFunction", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Function deleted." + }, + "404": { + "description": "Function does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/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_ListFunctionSecrets", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Function secrets returned.", + "schema": { + "$ref": "#/definitions/FunctionSecrets" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { "get": { "tags": [ @@ -2732,10 +3280,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding" + "description": "Succesfully deleted hostname binding." }, "204": { - "description": "Hostname binding does not exist" + "description": "Hostname binding does not exist." } } } @@ -2761,21 +3309,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", - "description": "The namespace for this 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", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, @@ -2820,28 +3368,28 @@ { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", - "description": "The namespace for this 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", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", - "description": "The details of the hybrid connection", + "description": "The details of the hybrid connection.", "required": true, "schema": { "$ref": "#/definitions/HybridConnection" @@ -2877,21 +3425,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", - "description": "The namespace for this 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", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, @@ -2936,28 +3484,28 @@ { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", - "description": "The namespace for this 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", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", - "description": "The details of the hybrid connection", + "description": "The details of the hybrid connection.", "required": true, "schema": { "$ref": "#/definitions/HybridConnection" @@ -3001,21 +3549,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", - "description": "The namespace for this 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", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, @@ -3057,7 +3605,7 @@ { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "The name of the web app.", "required": true, "type": "string" }, @@ -3375,17 +3923,19 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], - "summary": "List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.", - "description": "List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.", - "operationId": "WebApps_ListInstanceDeployments", + "summary": "Get the status of the last MSDeploy operation.", + "description": "Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMsDeployStatus", "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3394,14 +3944,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", - "description": "The 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" }, @@ -3416,23 +3966,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DeploymentCollection" + "$ref": "#/definitions/MSDeployStatus" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_GetInstanceDeployment", + "summary": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateInstanceMSDeployOperation", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -3446,23 +3996,25 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "id", + "name": "instanceId", "in": "path", - "description": "Deployment ID.", + "description": "ID of web app instance.", "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": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MSDeploy" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -3472,26 +4024,27 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Deployment is scheduled.", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/MSDeployStatus" } + }, + "409": { + "description": "Another deployment is in progress." } - } - }, - "put": { + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": { + "get": { "tags": [ "WebApps" ], - "summary": "Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_CreateInstanceDeployment", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMSDeployLog", "produces": [ "application/json", "text/json", @@ -3505,33 +4058,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": "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" }, - { - "name": "deployment", - "in": "body", - "description": "Deployment details.", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3541,20 +4078,29 @@ ], "responses": { "200": { - "description": "OK", + "description": "MSDeploy log returned.", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/MSDeployLog" } + }, + "404": { + "description": "MSDeploy log not found." } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": { + "get": { "tags": [ "WebApps" ], - "summary": "Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_DeleteInstanceDeployment", + "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", + "produces": [ + "application/json", + "text/json" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -3562,21 +4108,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Deployment ID.", + "description": "Site name.", "required": true, "type": "string" }, { "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 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" }, @@ -3589,22 +4128,28 @@ ], "responses": { "200": { - "description": "Succesfully deleted deployment" + "description": "Process terminated.", + "schema": { + "$ref": "#/definitions/ProcessInfoCollection" + } }, - "204": { - "description": "Deployment does not exist" + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": { "get": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension as pass-through API", - "description": "Invoke the MSDeploy web app extension as pass-through API", - "operationId": "WebApps_GetInstanceMsDeployStatus", + "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", "produces": [ "application/json", "text/json", @@ -3618,14 +4163,21 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", - "description": "Id of web app instance", + "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" }, @@ -3638,31 +4190,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process information returned.", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/ProcessInfo" } + }, + "404": { + "description": "Process with the specified ID is not running." } } }, - "put": { + "delete": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension as pass-through API", - "description": "Invoke the MSDeploy web app extension as pass-through API", - "operationId": "WebApps_CreateInstanceMSDeployOperation", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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" @@ -3670,25 +4214,23 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "processId", "in": "path", - "description": "Id of web app instance", + "description": "PID.", "required": true, "type": "string" }, { - "name": "MSDeploy", - "in": "body", - "description": "Details of MSDeploy operation", + "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, - "schema": { - "$ref": "#/definitions/MSDeploy" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -3698,33 +4240,23 @@ } ], "responses": { - "201": { - "description": "Deployment is scheduled", - "schema": { - "$ref": "#/definitions/MSDeployStatus" - } + "204": { + "description": "Process terminated." }, - "409": { - "description": "Another deployment is in progress" + "404": { + "description": "Process with the specified ID is not running." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": { "get": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy Log web app extension as pass-through API", - "description": "Invoke the MSDeploy Log web app extension as pass-through API", - "operationId": "WebApps_GetInstanceMSDeployLog", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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" @@ -3732,14 +4264,21 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", - "description": "Id of web app instance", + "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" }, @@ -3754,25 +4293,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployLog" + "type": "file" } + }, + "404": { + "description": "Process with the specified ID is not running." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": { + "get": { "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": "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", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -3781,7 +4321,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" }, @@ -3794,25 +4348,33 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "#/definitions/SiteCloneability" + "$ref": "#/definitions/ProcessModuleInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{base_address}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets all metric definitions of an app (or deployment slot, if specified).", - "description": "Gets all metric definitions of an app (or deployment slot, if specified).", - "operationId": "WebApps_ListMetricDefinitions", + "summary": "Get 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", "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3821,7 +4383,34 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "baseAddress", + "in": "query", + "description": "Module base address.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, + "type": "string" + }, + { + "name": "base_address", + "in": "path", "required": true, "type": "string" }, @@ -3834,25 +4423,25 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "#/definitions/ResourceMetricDefinitionCollection" + "$ref": "#/definitions/ProcessModuleInfo" } + }, + "404": { + "description": "Process with the specified ID is not running, or a module with the specified base_address was not found." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": { "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": "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", "produces": [ "application/json", "text/json" @@ -3864,21 +4453,22 @@ { "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]'.", - "x-ms-skip-url-encoding": true, + "name": "instanceId", + "in": "path", + "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", + "required": true, "type": "string" }, { @@ -3890,10 +4480,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "#/definitions/ResourceMetricCollection" + "$ref": "#/definitions/ProcessThreadInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { @@ -3901,19 +4494,14 @@ } } }, - "/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/{threadId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Restores a web app.", - "description": "Restores a web app.", - "operationId": "WebApps_MigrateStorage", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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", "produces": [ "application/json", "text/json", @@ -3922,30 +4510,35 @@ ], "parameters": [ { - "name": "subscriptionName", - "in": "query", - "description": "Azure subscription", + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", "required": true, "type": "string" }, { - "$ref": "#/parameters/resourceGroupNameParameter" + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" }, { - "name": "name", + "name": "threadId", "in": "path", - "description": "Name of web app", + "description": "TID.", "required": true, "type": "string" }, { - "name": "migrationOptions", - "in": "body", - "description": "Migration migrationOptions", + "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, - "schema": { - "$ref": "#/definitions/StorageMigrationOptions" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -3956,21 +4549,270 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "#/definitions/StorageMigrationResponse" + "$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." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { "post": { "tags": [ "WebApps" ], - "summary": "Migrates a local (in-app) MySql database to a remote MySql database.", + "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", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SiteCloneability" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "This is to allow calling via powershell and ARM template.", + "description": "This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncFunctionTriggers", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "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/FunctionSecrets" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets all metric definitions of an app (or deployment slot, if specified).", + "description": "Gets all metric definitions of an app (or deployment slot, if specified).", + "operationId": "WebApps_ListMetricDefinitions", + "produces": [ + "application/json", + "text/json" + ], + "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/ResourceMetricDefinitionCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets performance metrics of an app (or deployment slot, if specified).", + "description": "Gets performance metrics of an app (or deployment slot, if specified).", + "operationId": "WebApps_ListMetrics", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "Specify \"true\" to include metric details in the response. It is \"false\" by default.", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only metrics specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "x-ms-skip-url-encoding": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": { + "put": { + "tags": [ + "WebApps" + ], + "summary": "Restores a web app.", + "description": "Restores a web app.", + "operationId": "WebApps_MigrateStorage", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "subscriptionName", + "in": "query", + "description": "Azure subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "migrationOptions", + "in": "body", + "description": "Migration migrationOptions.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageMigrationOptions" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageMigrationResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Migrates a local (in-app) MySql database to a remote MySql database.", "description": "Migrates a local (in-app) MySql database to a remote MySql database.", "operationId": "WebApps_MigrateMySql", "consumes": [ @@ -3991,14 +4833,14 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "migrationRequestEnvelope", "in": "body", - "description": "MySql migration options", + "description": "MySql migration options.", "required": true, "schema": { "$ref": "#/definitions/MigrateMySqlRequest" @@ -4043,7 +4885,7 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -4105,7 +4947,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { "$ref": "#/definitions/NetworkFeatures" } @@ -4170,7 +5012,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { "type": "string" } @@ -4212,7 +5054,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { "type": "string" } @@ -4272,7 +5114,7 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -4324,7 +5166,7 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app.", "required": true, "type": "string" }, @@ -4535,14 +5377,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { "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", + "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", "produces": [ "application/json", "text/json" @@ -4554,7 +5396,7 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, @@ -4567,10 +5409,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process terminated.", "schema": { - "$ref": "#/definitions/PublicCertificateCollection" + "$ref": "#/definitions/ProcessInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { @@ -4578,14 +5423,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": { "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 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", "produces": [ "application/json", "text/json", @@ -4599,14 +5444,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 CertificateName", + "description": "PID.", "required": true, "type": "string" }, @@ -4619,31 +5464,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process information returned.", "schema": { - "$ref": "#/definitions/PublicCertificate" + "$ref": "#/definitions/ProcessInfo" } + }, + "404": { + "description": "Process with the specified ID is not running." } } }, - "put": { + "delete": { "tags": [ "WebApps" ], - "summary": "Creates a hostname binding for an app.", - "description": "Creates a hostname binding for an app.", - "operationId": "WebApps_CreateOrUpdatePublicCertificate", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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" @@ -4651,26 +5488,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" }, @@ -4679,21 +5507,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PublicCertificate" - } + "204": { + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running." } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes a hostname binding for an app.", - "description": "Deletes a hostname binding for an app.", - "operationId": "WebApps_DeletePublicCertificate", + "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" @@ -4701,14 +5531,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" }, @@ -4721,34 +5551,28 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding" + "description": "OK", + "schema": { + "type": "file" + } }, - "204": { - "description": "Hostname binding does not exist" + "404": { + "description": "Process with the specified ID is not running." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": { + "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", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], + "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", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -4757,18 +5581,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" @@ -4779,26 +5601,33 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "type": "file" + "$ref": "#/definitions/ProcessModuleInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{base_address}": { + "get": { "tags": [ "WebApps" ], - "summary": "Recovers a web app to a previous snapshot.", - "description": "Recovers a web app to a previous snapshot.", - "operationId": "WebApps_Recover", - "consumes": [ + "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", + "produces": [ "application/json", "text/json", - "application/x-www-form-urlencoded" + "application/xml", + "text/xml" ], "parameters": [ { @@ -4807,18 +5636,29 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "recoveryEntity", - "in": "body", - "description": "Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "name": "processId", + "in": "path", + "description": "PID.", "required": true, - "schema": { - "$ref": "#/definitions/SnapshotRecoveryRequest" - } + "type": "string" + }, + { + "name": "baseAddress", + "in": "query", + "description": "Module base address.", + "required": true, + "type": "string" + }, + { + "name": "base_address", + "in": "path", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4828,21 +5668,30 @@ } ], "responses": { - "202": { - "description": "Recovery operation started" + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running, or a module with the specified base_address was not found." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": { + "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": "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", + "produces": [ + "application/json", + "text/json" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4850,7 +5699,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" }, @@ -4863,19 +5719,34 @@ ], "responses": { "200": { - "description": "OK" + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId}": { + "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": "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", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -4883,21 +5754,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "softRestart", - "in": "query", - "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", - "type": "boolean" + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" }, { - "name": "synchronous", - "in": "query", - "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", - "type": "boolean" + "name": "threadId", + "in": "path", + "description": "TID.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -4908,19 +5781,25 @@ ], "responses": { "200": { - "description": "Successfully restarted app." + "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}/slots": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { "get": { "tags": [ "WebApps" ], - "summary": "Gets an app's deployment slots.", - "description": "Gets an app's deployment slots.", - "operationId": "WebApps_ListSlots", + "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", "produces": [ "application/json", "text/json" @@ -4947,7 +5826,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WebAppCollection" + "$ref": "#/definitions/PublicCertificateCollection" } } }, @@ -4956,14 +5835,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { "get": { "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": "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", "produces": [ "application/json", "text/json", @@ -4982,9 +5861,9 @@ "type": "string" }, { - "name": "slot", + "name": "publicCertificateName", "in": "path", - "description": "Name of the deployment slot. By default, this API returns the production slot.", + "description": "Public certificate name.", "required": true, "type": "string" }, @@ -4999,7 +5878,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Site" + "$ref": "#/definitions/PublicCertificate" } } } @@ -5008,9 +5887,9 @@ "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": "Creates a hostname binding for an app.", + "description": "Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdatePublicCertificate", "consumes": [ "application/json", "text/json", @@ -5029,49 +5908,25 @@ { "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/Site" - } - }, - { - "name": "slot", + "name": "publicCertificateName", "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": "Public certificate name.", "required": true, "type": "string" }, { - "name": "skipDnsRegistration", - "in": "query", - "description": "If true web app hostname is not registered with DNS on creation. This parameter is\n only used for app creation", - "type": "boolean" - }, - { - "name": "skipCustomDomainVerification", - "in": "query", - "description": "If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.", - "type": "boolean" - }, - { - "name": "forceDnsRegistration", - "in": "query", - "description": "If true, web app hostname is force registered with DNS", - "type": "boolean" - }, - { - "name": "ttlInSeconds", - "in": "query", - "description": "Time to live in seconds for web app's default domain name", - "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" @@ -5084,25 +5939,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Site" - } - }, - "202": { - "description": "Asynchronous operation in progress", - "schema": { - "$ref": "#/definitions/Site" + "$ref": "#/definitions/PublicCertificate" } } - }, - "x-ms-long-running-operation": true + } }, "delete": { "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": "Deletes a hostname binding for an app.", + "description": "Deletes a hostname binding for an app.", + "operationId": "WebApps_DeletePublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -5110,35 +5958,17 @@ { "name": "name", "in": "path", - "description": "Name of the app to delete.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "slot", + "name": "publicCertificateName", "in": "path", - "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.", + "description": "Public certificate name.", "required": true, "type": "string" }, - { - "name": "deleteMetrics", - "in": "query", - "description": "If true, web app metrics are also deleted", - "type": "boolean" - }, - { - "name": "deleteEmptyServerFarm", - "in": "query", - "description": "Specify true if the App Service plan will be empty after app deletion and you want to delete the empty App Service plan. By default, the empty App Service plan is not deleted.", - "type": "boolean" - }, - { - "name": "skipDnsRegistration", - "in": "query", - "description": "If true, DNS registration is skipped", - "type": "boolean" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5148,22 +5978,29 @@ ], "responses": { "200": { - "description": "Succesfully deleted web app" + "description": "Succesfully deleted hostname binding." }, - "404": { - "description": "Web app not found" + "204": { + "description": "Hostname binding does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { + "post": { "tags": [ "WebApps" ], - "summary": "Analyze a custom hostname.", - "description": "Analyze a custom hostname.", - "operationId": "WebApps_AnalyzeCustomHostnameSlot", + "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", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -5177,22 +6014,18 @@ { "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": "publishingProfileOptions", + "in": "body", + "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", "required": true, - "type": "string" - }, - { - "name": "hostName", - "in": "query", - "description": "Custom hostname", - "type": "string" + "schema": { + "$ref": "#/definitions/CsmPublishingProfileOptions" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -5205,25 +6038,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CustomHostnameAnalysisResult" + "type": "file" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover": { "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": "Recovers a web app to a previous snapshot.", + "description": "Recovers a web app to a previous snapshot.", + "operationId": "WebApps_Recover", "consumes": [ "application/json", "text/json", - "application/xml", - "text/xml", "application/x-www-form-urlencoded" ], "parameters": [ @@ -5233,23 +6064,50 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "slotSwapEntity", + "name": "recoveryEntity", "in": "body", - "description": "JSON object that contains the target slot name. See example.", + "description": "Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", "required": true, "schema": { - "$ref": "#/definitions/CsmSlotEntity" + "$ref": "#/definitions/SnapshotRecoveryRequest" } }, { - "name": "slot", + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Recovery operation started." + } + }, + "x-ms-long-running-operation": true + } + }, + "/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 source slot. If a slot is not specified, the production slot is used as the source slot.", + "description": "Name of the app.", "required": true, "type": "string" }, @@ -5262,30 +6120,19 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { "post": { "tags": [ "WebApps" ], - "summary": "Creates a backup of an app.", - "description": "Creates a backup of an app.", - "operationId": "WebApps_BackupSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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" @@ -5298,20 +6145,16 @@ "type": "string" }, { - "name": "request", - "in": "body", - "description": "Backup configuration. You can use the JSON response from the POST action as input here.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } + "name": "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": "slot", - "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.", - "required": true, - "type": "string" + "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" @@ -5322,22 +6165,19 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } + "description": "Successfully restarted app." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { "get": { "tags": [ "WebApps" ], - "summary": "Gets existing backups of an app.", - "description": "Gets existing backups of an app.", - "operationId": "WebApps_ListBackupsSlot", + "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", "produces": [ "application/json", "text/json" @@ -5349,14 +6189,7 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.", + "description": "Site name.", "required": true, "type": "string" }, @@ -5369,10 +6202,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "SiteExtension information returned.", "schema": { - "$ref": "#/definitions/BackupItemCollection" + "$ref": "#/definitions/SiteExtensionInfoCollection" } + }, + "404": { + "description": "SiteExtension not found." } }, "x-ms-pageable": { @@ -5380,19 +6216,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{extensionName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage.", - "description": "Discovers an existing app backup that can be restored from a blob in Azure storage.", - "operationId": "WebApps_DiscoverRestoreSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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", "produces": [ "application/json", "text/json", @@ -5406,23 +6237,20 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "request", - "in": "body", - "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", + "name": "siteExtensionId", + "in": "query", + "description": "Site extension name.", "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } + "type": "string" }, { - "name": "slot", + "name": "extensionName", "in": "path", - "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" }, @@ -5435,22 +6263,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "SiteExtension information returned.", "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/SiteExtensionInfo" } + }, + "404": { + "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { - "get": { + }, + "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": "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", "produces": [ "application/json", "text/json", @@ -5464,21 +6293,20 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", + "name": "siteExtensionId", + "in": "query", + "description": "Site extension name.", "required": true, "type": "string" }, { - "name": "slot", + "name": "extensionName", "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" }, @@ -5490,21 +6318,31 @@ } ], "responses": { + "201": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, "200": { - "description": "OK", + "description": "Site Extension created.", "schema": { - "$ref": "#/definitions/BackupItem" + "$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": "Deletes a backup of an app by its ID.", - "description": "Deletes a backup of an app by its ID.", - "operationId": "WebApps_DeleteBackupSlot", + "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" @@ -5512,21 +6350,20 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", + "name": "siteExtensionId", + "in": "query", + "description": "Site extension name.", "required": true, "type": "string" }, { - "name": "slot", + "name": "extensionName", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.", "required": true, "type": "string" }, @@ -5538,33 +6375,26 @@ } ], "responses": { - "200": { - "description": "Succesfully deleted web app backup item." + "204": { + "description": "SiteExtension terminated." }, "404": { - "description": "Web app backup item does not exist." + "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } } }, - "/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": { + "get": { "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", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets an app's deployment slots.", + "description": "Gets an app's deployment slots.", + "operationId": "WebApps_ListSlots", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -5573,30 +6403,59 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" + "$ref": "#/parameters/subscriptionIdParameter" }, { - "name": "request", - "in": "body", - "description": "Information on backup request", - "required": true, + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/WebAppCollection" } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": { + "get": { + "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", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "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. By default, this API returns the production slot.", "required": true, "type": "string" }, @@ -5611,20 +6470,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/Site" } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Restores a specific backup to another app (or deployment slot, if specified).", - "description": "Restores a specific backup to another app (or deployment slot, if specified).", - "operationId": "WebApps_RestoreSlot", + "summary": "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", "consumes": [ "application/json", "text/json", @@ -5643,33 +6500,50 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "ID of the backup.", + "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.", "required": true, "type": "string" }, { - "name": "request", + "name": "siteEnvelope", "in": "body", - "description": "Information on restore request", + "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/Site" } }, { "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 to create or update. By default, this API attempts to create or modify the production slot.", "required": true, "type": "string" }, + { + "name": "skipDnsRegistration", + "in": "query", + "description": "If true web app hostname is not registered with DNS on creation. This parameter is\n only used for app creation.", + "type": "boolean" + }, + { + "name": "skipCustomDomainVerification", + "in": "query", + "description": "If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.", + "type": "boolean" + }, + { + "name": "forceDnsRegistration", + "in": "query", + "description": "If true, web app hostname is force registered with DNS.", + "type": "boolean" + }, + { + "name": "ttlInSeconds", + "in": "query", + "description": "Time to live in seconds for web app's default domain name.", + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5679,27 +6553,27 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { - "$ref": "#/definitions/RestoreResponse" + "$ref": "#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress.", + "schema": { + "$ref": "#/definitions/Site" } } }, "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "List the configurations of an app", - "description": "List the configurations of an app", - "operationId": "WebApps_ListConfigurationsSlot", - "produces": [ - "application/json", - "text/json" - ], + "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" @@ -5707,17 +6581,35 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of the app to delete.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.", "required": true, "type": "string" }, + { + "name": "deleteMetrics", + "in": "query", + "description": "If true, web app metrics are also deleted.", + "type": "boolean" + }, + { + "name": "deleteEmptyServerFarm", + "in": "query", + "description": "Specify true if the App Service plan will be empty after app deletion and you want to delete the empty App Service plan. By default, the empty App Service plan is not deleted.", + "type": "boolean" + }, + { + "name": "skipDnsRegistration", + "in": "query", + "description": "If true, DNS registration is skipped.", + "type": "boolean" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5727,30 +6619,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfigResourceCollection" - } + "description": "Succesfully deleted web app." + }, + "404": { + "description": "Web app not found." } - }, - "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}/analyzeCustomHostname": { + "get": { "tags": [ "WebApps" ], - "summary": "Replaces the application settings of an app.", - "description": "Replaces the application settings of an app.", - "operationId": "WebApps_UpdateApplicationSettingsSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Analyze a custom hostname.", + "description": "Analyze a custom hostname.", + "operationId": "WebApps_AnalyzeCustomHostnameSlot", "produces": [ "application/json", "text/json", @@ -5764,26 +6648,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, - { - "name": "appSettings", - "in": "body", - "description": "Application settings of the app.", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, + { + "name": "hostName", + "in": "query", + "description": "Custom hostname.", + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5795,25 +6676,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/CustomHostnameAnalysisResult" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the application settings of an app.", - "description": "Gets the application settings of an app.", - "operationId": "WebApps_ListApplicationSettingsSlot", - "produces": [ + "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", + "consumes": [ "application/json", "text/json", "application/xml", - "text/xml" + "text/xml", + "application/x-www-form-urlencoded" ], "parameters": [ { @@ -5826,10 +6708,19 @@ "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 deployment slot. If a slot is not specified, the API will get the application settings for the production slot.", + "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" }, @@ -5842,22 +6733,19 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } + "description": "OK." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { + "post": { "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": "Creates a backup of an app.", + "description": "Creates a backup of an app.", + "operationId": "WebApps_BackupSlot", "consumes": [ "application/json", "text/json", @@ -5876,23 +6764,23 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "siteAuthSettings", + "name": "request", "in": "body", - "description": "Auth settings associated with web app", + "description": "Backup configuration. You can use the JSON response from the POST action as input here.", "required": true, "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/BackupRequest" } }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.", "required": true, "type": "string" }, @@ -5907,25 +6795,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/BackupItem" } } } } }, - "/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}/backups": { + "get": { "tags": [ "WebApps" ], - "summary": "Gets the Authentication/Authorization settings of an app.", - "description": "Gets the Authentication/Authorization settings of an app.", - "operationId": "WebApps_GetAuthSettingsSlot", + "summary": "Gets existing backups of an app.", + "description": "Gets existing backups of an app.", + "operationId": "WebApps_ListBackupsSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -5941,7 +6827,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.", "required": true, "type": "string" }, @@ -5956,20 +6842,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/BackupItemCollection" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover": { "put": { "tags": [ "WebApps" ], - "summary": "Updates the backup configuration of an app.", - "description": "Updates the backup configuration of an app.", - "operationId": "WebApps_UpdateBackupConfigurationSlot", + "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage.", + "description": "Discovers an existing app backup that can be restored from a blob in Azure storage.", + "operationId": "WebApps_DiscoverRestoreSlot", "consumes": [ "application/json", "text/json", @@ -5995,16 +6884,16 @@ { "name": "request", "in": "body", - "description": "Edited backup configuration.", + "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", "required": true, "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/RestoreRequest" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.", "required": true, "type": "string" }, @@ -6019,18 +6908,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/RestoreRequest" } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes the backup configuration of an app.", - "description": "Deletes the backup configuration of an app.", - "operationId": "WebApps_DeleteBackupConfigurationSlot", + "summary": "Gets a backup of an app by its ID.", + "description": "Gets a backup of an app by its ID.", + "operationId": "WebApps_GetBackupStatusSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6042,10 +6939,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. If a slot is not specified, the API will delete the backup configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.", "required": true, "type": "string" }, @@ -6058,25 +6962,20 @@ ], "responses": { "200": { - "description": "Succesfully deleted backup configuration." + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { - "post": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets the backup configuration of an app.", - "description": "Gets the backup configuration of an app.", - "operationId": "WebApps_GetBackupConfigurationSlot", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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" @@ -6088,10 +6987,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. 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 delete a backup of the production slot.", "required": true, "type": "string" }, @@ -6104,22 +7010,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupRequest" - } + "description": "Succesfully deleted web app backup item." + }, + "404": { + "description": "Web app backup item does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Replaces the connection strings of an app.", - "description": "Replaces the connection strings of an app.", - "operationId": "WebApps_UpdateConnectionStringsSlot", + "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", "consumes": [ "application/json", "text/json", @@ -6138,23 +7044,30 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "connectionStrings", + "name": "backupId", + "in": "path", + "description": "ID of backup.", + "required": true, + "type": "string" + }, + { + "name": "request", "in": "body", - "description": "Connection strings of the app or deployment slot. See example.", + "description": "Information on backup request.", "required": true, "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/BackupRequest" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -6169,20 +7082,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/BackupItem" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { "post": { "tags": [ "WebApps" ], - "summary": "Gets the connection strings of an app.", - "description": "Gets the connection strings of an app.", - "operationId": "WebApps_ListConnectionStringsSlot", + "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", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -6200,10 +7118,26 @@ "required": true, "type": "string" }, + { + "name": "backupId", + "in": "path", + "description": "ID of the backup.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request .", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. 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 restore a backup of the production slot.", "required": true, "type": "string" }, @@ -6218,25 +7152,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/RestoreResponse" } } - } + }, + "x-ms-long-running-operation": true } }, - "/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": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the logging configuration of an app.", - "description": "Gets the logging configuration of an app.", - "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot", + "summary": "List the configurations of an app", + "description": "List the configurations of an app", + "operationId": "WebApps_ListConfigurationsSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -6252,7 +7185,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" }, @@ -6267,18 +7200,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/SiteConfigResourceCollection" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { "put": { "tags": [ "WebApps" ], - "summary": "Updates the logging configuration of an app.", - "description": "Updates the logging configuration of an app.", - "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", + "summary": "Replaces the application settings of an app.", + "description": "Replaces the application settings of an app.", + "operationId": "WebApps_UpdateApplicationSettingsSlot", "consumes": [ "application/json", "text/json", @@ -6302,18 +7240,18 @@ "type": "string" }, { - "name": "siteLogsConfig", + "name": "appSettings", "in": "body", - "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", + "description": "Application settings of the app.", "required": true, "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/StringDictionary" } }, { "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 update the application settings for the production slot.", "required": true, "type": "string" }, @@ -6328,25 +7266,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/StringDictionary" } } } } }, - "/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/appsettings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Replaces the metadata of an app.", - "description": "Replaces the metadata of an app.", - "operationId": "WebApps_UpdateMetadataSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets the application settings of an app.", + "description": "Gets the application settings of an app.", + "operationId": "WebApps_ListApplicationSettingsSlot", "produces": [ "application/json", "text/json", @@ -6364,19 +7297,10 @@ "required": true, "type": "string" }, - { - "name": "metadata", - "in": "body", - "description": "Edited metadata of the app or deployment slot. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.", "required": true, "type": "string" }, @@ -6397,14 +7321,19 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { + "put": { "tags": [ "WebApps" ], - "summary": "Gets the metadata of an app.", - "description": "Gets the metadata of an app.", - "operationId": "WebApps_ListMetadataSlot", + "summary": "Updates the Authentication / Authorization settings associated with web app.", + "description": "Updates the Authentication / Authorization settings associated with web app.", + "operationId": "WebApps_UpdateAuthSettingsSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -6418,14 +7347,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, + { + "name": "siteAuthSettings", + "in": "body", + "description": "Auth settings associated with web app.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, { "name": "slot", "in": "path", - "description": "Name of 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" }, @@ -6440,20 +7378,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteAuthSettings" } } } } }, - "/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}/config/authsettings/list": { "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 Authentication/Authorization settings of an app.", + "description": "Gets the Authentication/Authorization settings of an app.", + "operationId": "WebApps_GetAuthSettingsSlot", "produces": [ "application/json", "text/json", @@ -6474,7 +7412,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.", "required": true, "type": "string" }, @@ -6489,21 +7427,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/User" + "$ref": "#/definitions/SiteAuthSettings" } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { "put": { "tags": [ "WebApps" ], - "summary": "Updates the Push settings associated with web app.", - "description": "Updates the Push settings associated with web app.", - "operationId": "WebApps_UpdateSitePushSettingsSlot", + "summary": "Updates the backup configuration of an app.", + "description": "Updates the backup configuration of an app.", + "operationId": "WebApps_UpdateBackupConfigurationSlot", "consumes": [ "application/json", "text/json", @@ -6522,23 +7459,23 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "pushSettings", + "name": "request", "in": "body", - "description": "Push settings associated with web app", + "description": "Edited backup configuration.", "required": true, "schema": { - "$ref": "#/definitions/PushSettings" + "$ref": "#/definitions/BackupRequest" } }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.", "required": true, "type": "string" }, @@ -6553,26 +7490,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PushSettings" + "$ref": "#/definitions/BackupRequest" } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { - "post": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets the Push settings associated with web app.", - "description": "Gets the Push settings associated with web app.", - "operationId": "WebApps_ListSitePushSettingsSlot", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "summary": "Deletes the backup configuration of an app.", + "description": "Deletes the backup configuration of an app.", + "operationId": "WebApps_DeleteBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6580,14 +7509,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. If a slot is not specified, the API will delete the backup configuration for the production slot.", "required": true, "type": "string" }, @@ -6600,22 +7529,19 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PushSettings" - } + "description": "Succesfully deleted backup configuration." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", - "description": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.", - "operationId": "WebApps_GetConfigurationSlot", + "summary": "Gets the backup configuration of an app.", + "description": "Gets the backup configuration of an app.", + "operationId": "WebApps_GetBackupConfigurationSlot", "produces": [ "application/json", "text/json", @@ -6636,7 +7562,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.", "required": true, "type": "string" }, @@ -6651,18 +7577,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/BackupRequest" } } } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { "put": { "tags": [ "WebApps" ], - "summary": "Updates the configuration of an app.", - "description": "Updates the configuration of an app.", - "operationId": "WebApps_CreateOrUpdateConfigurationSlot", + "summary": "Replaces the connection strings of an app.", + "description": "Replaces the connection strings of an app.", + "operationId": "WebApps_UpdateConnectionStringsSlot", "consumes": [ "application/json", "text/json", @@ -6686,18 +7614,18 @@ "type": "string" }, { - "name": "siteConfig", + "name": "connectionStrings", "in": "body", - "description": "JSON representation of a SiteConfig object. See example.", + "description": "Connection strings of the app or deployment slot. See example.", "required": true, "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/ConnectionStringDictionary" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.", "required": true, "type": "string" }, @@ -6712,23 +7640,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/ConnectionStringDictionary" } } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Updates the configuration of an app.", - "description": "Updates the configuration of an app.", - "operationId": "WebApps_UpdateConfigurationSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets the connection strings of an app.", + "description": "Gets the connection strings of an app.", + "operationId": "WebApps_ListConnectionStringsSlot", "produces": [ "application/json", "text/json", @@ -6746,19 +7671,10 @@ "required": true, "type": "string" }, - { - "name": "siteConfig", - "in": "body", - "description": "JSON representation of a SiteConfig object. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/SiteConfigResource" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.", "required": true, "type": "string" }, @@ -6773,20 +7689,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/ConnectionStringDictionary" } } } } }, - "/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}/config/logs": { "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": "Gets the logging configuration of an app.", + "description": "Gets the logging configuration of an app.", + "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot", "produces": [ "application/json", "text/json", @@ -6807,7 +7723,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.", "required": true, "type": "string" }, @@ -6822,23 +7738,23 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/SiteConfigurationSnapshotInfo" - } + "$ref": "#/definitions/SiteLogsConfig" } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets a snapshot of the configuration of an app at a previous point in time.", - "description": "Gets a snapshot of the configuration of an app at a previous point in time.", - "operationId": "WebApps_GetConfigurationSnapshotSlot", + "summary": "Updates the logging configuration of an app.", + "description": "Updates the logging configuration of an app.", + "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -6857,16 +7773,18 @@ "type": "string" }, { - "name": "snapshotId", - "in": "path", - "description": "The ID of the snapshot to read.", + "name": "siteLogsConfig", + "in": "body", + "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.", "required": true, "type": "string" }, @@ -6881,20 +7799,31 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/SiteLogsConfig" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { + "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": "Replaces the metadata of an app.", + "description": "Replaces the metadata of an app.", + "operationId": "WebApps_UpdateMetadataSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -6907,16 +7836,18 @@ "type": "string" }, { - "name": "snapshotId", - "in": "path", - "description": "The ID of the snapshot to read.", + "name": "metadata", + "in": "body", + "description": "Edited metadata of the app or deployment slot. See example.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/StringDictionary" + } }, { "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 metadata for the production slot.", "required": true, "type": "string" }, @@ -6928,23 +7859,28 @@ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { + "post": { "tags": [ "WebApps" ], - "summary": "List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.", - "description": "List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.", - "operationId": "WebApps_ListDeploymentsSlot", + "summary": "Gets the metadata of an app.", + "description": "Gets the metadata of an app.", + "operationId": "WebApps_ListMetadataSlot", "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -6960,7 +7896,7 @@ { "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 get the metadata for the production slot.", "required": true, "type": "string" }, @@ -6975,23 +7911,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DeploymentCollection" + "$ref": "#/definitions/StringDictionary" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_GetDeploymentSlot", + "summary": "Gets the Git/FTP publishing credentials of an app.", + "description": "Gets the Git/FTP publishing credentials of an app.", + "operationId": "WebApps_ListPublishingCredentialsSlot", "produces": [ "application/json", "text/json", @@ -7009,17 +7942,10 @@ "required": true, "type": "string" }, - { - "name": "id", - "in": "path", - "description": "Deployment ID.", - "required": true, - "type": "string" - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment 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" }, @@ -7034,18 +7960,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/User" } } - } - }, + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { "put": { "tags": [ "WebApps" ], - "summary": "Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_CreateDeploymentSlot", + "summary": "Updates the Push settings associated with web app.", + "description": "Updates the Push settings associated with web app.", + "operationId": "WebApps_UpdateSitePushSettingsSlot", "consumes": [ "application/json", "text/json", @@ -7064,33 +7993,26 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "id", - "in": "path", - "description": "ID of an existing deployment.", + "name": "pushSettings", + "in": "body", + "description": "Push settings associated with web app.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/PushSettings" + } }, { "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" }, @@ -7102,18 +8024,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/PushSettings" } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { + "post": { "tags": [ "WebApps" ], - "summary": "Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_DeleteDeploymentSlot", + "summary": "Gets the Push settings associated with web app.", + "description": "Gets the Push settings associated with web app.", + "operationId": "WebApps_ListSitePushSettingsSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7121,21 +8051,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Deployment ID.", + "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -7148,25 +8071,27 @@ ], "responses": { "200": { - "description": "Succesfully deleted deployment" - }, - "204": { - "description": "Deployment does not exist" + "description": "OK", + "schema": { + "$ref": "#/definitions/PushSettings" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { "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": "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", "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -7182,7 +8107,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -7197,23 +8122,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IdentifierCollection" + "$ref": "#/definitions/SiteConfigResource" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Get domain ownership identifier for web app.", - "description": "Get domain ownership identifier for web app.", - "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", + "summary": "Updates the configuration of an app.", + "description": "Updates the configuration of an app.", + "operationId": "WebApps_CreateOrUpdateConfigurationSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -7232,16 +8157,18 @@ "type": "string" }, { - "name": "domainOwnershipIdentifierName", - "in": "path", - "description": "Name of domain ownership identifier.", + "name": "siteConfig", + "in": "body", + "description": "JSON representation of a SiteConfig object. See example.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", "required": true, "type": "string" }, @@ -7256,18 +8183,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Identifier" + "$ref": "#/definitions/SiteConfigResource" } } } }, - "put": { + "patch": { "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": "Updates the configuration of an app.", + "description": "Updates the configuration of an app.", + "operationId": "WebApps_UpdateConfigurationSlot", "consumes": [ "application/json", "text/json", @@ -7291,25 +8218,18 @@ "type": "string" }, { - "name": "domainOwnershipIdentifierName", - "in": "path", - "description": "Name of domain ownership identifier.", - "required": true, - "type": "string" - }, - { - "name": "domainOwnershipIdentifier", + "name": "siteConfig", "in": "body", - "description": "A JSON representation of the domain ownership properties.", + "description": "JSON representation of a SiteConfig object. See example.", "required": true, "schema": { - "$ref": "#/definitions/Identifier" + "$ref": "#/definitions/SiteConfigResource" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.", "required": true, "type": "string" }, @@ -7324,18 +8244,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Identifier" + "$ref": "#/definitions/SiteConfigResource" } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes a domain ownership identifier for a web app.", - "description": "Deletes a domain ownership identifier for a web app.", - "operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot", + "summary": "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", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7347,17 +8275,10 @@ "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 will delete the binding 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" }, @@ -7370,25 +8291,25 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain ownership identifier." - }, - "204": { - "description": "Domain ownership identifider does not exist." + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/SiteConfigurationSnapshotInfo" + } + } } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": { + "get": { "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", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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", "produces": [ "application/json", "text/json", @@ -7407,25 +8328,16 @@ "type": "string" }, { - "name": "domainOwnershipIdentifierName", + "name": "snapshotId", "in": "path", - "description": "Name of domain ownership identifier.", + "description": "The ID of the snapshot to read.", "required": true, "type": "string" }, - { - "name": "domainOwnershipIdentifier", - "in": "body", - "description": "A JSON representation of the domain ownership properties.", - "required": true, - "schema": { - "$ref": "#/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. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -7440,26 +8352,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Identifier" + "$ref": "#/definitions/SiteConfigResource" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": { + "post": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension as pass-through API", - "description": "Invoke the MSDeploy web app extension as pass-through API", - "operationId": "WebApps_GetMSDeployStatusSlot", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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" @@ -7467,14 +8373,21 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "snapshotId", + "in": "path", + "description": "The ID of the snapshot to read.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, @@ -7486,31 +8399,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MSDeployStatus" - } + "204": { + "description": "No Content" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { + "get": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension as pass-through API", - "description": "Invoke the MSDeploy web app extension as pass-through API", - "operationId": "WebApps_CreateMSDeployOperationSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -7519,26 +8424,17 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, - { - "name": "MSDeploy", - "in": "body", - "description": "Details of MSDeploy operation", - "required": true, - "schema": { - "$ref": "#/definitions/MSDeploy" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7547,27 +8443,26 @@ } ], "responses": { - "201": { - "description": "Deployment is scheduled", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/ContinuousWebJobCollection" } - }, - "409": { - "description": "Another deployment is in progress" } }, - "x-ms-long-running-operation": true + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": { "get": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy Log web app extension as pass-through API", - "description": "Invoke the MSDeploy Log web app extension as pass-through API", - "operationId": "WebApps_GetMSDeployLogSlot", + "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", "produces": [ "application/json", "text/json", @@ -7581,14 +8476,27 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job 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" + }, + { + "name": "webJobName", + "in": "path", "required": true, "type": "string" }, @@ -7601,28 +8509,135 @@ ], "responses": { "200": { - "description": "OK", + "description": "Found continuous web job.", "schema": { - "$ref": "#/definitions/MSDeployLog" + "$ref": "#/definitions/ContinuousWebJob" } + }, + "404": { + "description": "Continuous web job does not exist." + } + } + }, + "delete": { + "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", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "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" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted continuous web job." + }, + "204": { + "description": "Continuous web job does not exist." } } } }, - "/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}/continuouswebjobs/{webJobName}/start": { + "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", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" + "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" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "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" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Continuous web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": { + "post": { + "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -7630,14 +8645,27 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job 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" + }, + { + "name": "webJobName", + "in": "path", "required": true, "type": "string" }, @@ -7650,22 +8678,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "Found continuous web job." + }, + "404": { + "description": "Continuous web job does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { "get": { "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_ListHostNameBindingsSlot", + "summary": "List deployments for an app, or a deployment slot.", + "description": "List deployments for an app, or a deployment slot.", + "operationId": "WebApps_ListDeploymentsSlot", "produces": [ "application/json", "text/json" @@ -7684,7 +8712,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings 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" }, @@ -7699,7 +8727,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBindingCollection" + "$ref": "#/definitions/DeploymentCollection" } } }, @@ -7708,14 +8736,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { "get": { "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_GetHostNameBindingSlot", + "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", "produces": [ "application/json", "text/json", @@ -7734,16 +8762,16 @@ "type": "string" }, { - "name": "slot", + "name": "id", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.", + "description": "Deployment ID.", "required": true, "type": "string" }, { - "name": "hostName", + "name": "slot", "in": "path", - "description": "Hostname in the hostname binding.", + "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" }, @@ -7758,7 +8786,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Deployment" } } } @@ -7767,9 +8795,9 @@ "tags": [ "WebApps" ], - "summary": "Creates a hostname binding for an app.", - "description": "Creates a hostname binding for an app.", - "operationId": "WebApps_CreateOrUpdateHostNameBindingSlot", + "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", "consumes": [ "application/json", "text/json", @@ -7793,28 +8821,28 @@ "type": "string" }, { - "name": "hostName", + "name": "id", "in": "path", - "description": "Hostname in the hostname binding.", + "description": "ID of an existing deployment.", "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" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.", "required": true, "type": "string" }, + { + "name": "deployment", + "in": "body", + "description": "Deployment details.", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7826,7 +8854,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Deployment" } } } @@ -7835,9 +8863,9 @@ "tags": [ "WebApps" ], - "summary": "Deletes a hostname binding for an app.", - "description": "Deletes a hostname binding for an app.", - "operationId": "WebApps_DeleteHostNameBindingSlot", + "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" @@ -7850,16 +8878,16 @@ "type": "string" }, { - "name": "slot", + "name": "id", "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": "Deployment ID.", "required": true, "type": "string" }, { - "name": "hostName", + "name": "slot", "in": "path", - "description": "Hostname in the hostname binding.", + "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" }, @@ -7872,22 +8900,22 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding" + "description": "Succesfully deleted deployment." }, "204": { - "description": "Hostname binding does not exist" + "description": "Deployment does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": { "get": { "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_GetHybridConnectionSlot", + "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", "produces": [ "application/json", "text/json", @@ -7901,28 +8929,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "relayName", + "name": "id", "in": "path", - "description": "The relay name for this hybrid connection", + "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": "The name of the slot for the web app.", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, @@ -7937,28 +8958,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridConnection" + "$ref": "#/definitions/Deployment" } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { + "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_CreateOrUpdateHybridConnectionSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Lists ownership identifiers for domain associated with web app.", + "description": "Lists ownership identifiers for domain associated with web app.", + "operationId": "WebApps_ListDomainOwnershipIdentifiersSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -7967,37 +8983,14 @@ { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "namespaceName", + "name": "slot", "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": "#/definitions/HybridConnection" - } - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for the web app.", + "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" }, @@ -8012,18 +9005,29 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridConnection" + "$ref": "#/definitions/IdentifierCollection" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Removes a Hybrid Connection from this site.", - "description": "Removes a Hybrid Connection from this site.", - "operationId": "WebApps_DeleteHybridConnectionSlot", + "summary": "Get domain ownership identifier for web app.", + "description": "Get domain ownership identifier for web app.", + "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8031,28 +9035,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "relayName", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "The relay name for this hybrid connection", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "The name of the slot for the web app.", + "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" }, @@ -8065,20 +9062,20 @@ ], "responses": { "200": { - "description": "Succesfully deleted hybrid connection." - }, - "404": { - "description": "Hybrid connection does not exist." + "description": "OK", + "schema": { + "$ref": "#/definitions/Identifier" + } } } }, - "patch": { + "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_UpdateHybridConnectionSlot", + "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", "consumes": [ "application/json", "text/json", @@ -8097,37 +9094,30 @@ { "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": "domainOwnershipIdentifierName", "in": "path", - "description": "The relay name for this hybrid connection", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", + "name": "domainOwnershipIdentifier", "in": "body", - "description": "The details of the hybrid connection", + "description": "A JSON representation of the domain ownership properties.", "required": true, "schema": { - "$ref": "#/definitions/HybridConnection" + "$ref": "#/definitions/Identifier" } }, { "name": "slot", "in": "path", - "description": "The name of the slot for the web app.", + "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" }, @@ -8142,26 +9132,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridConnection" + "$ref": "#/definitions/Identifier" } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { - "post": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets the send key name and value for a Hybrid Connection.", - "description": "Gets the send key name and value for a Hybrid Connection.", - "operationId": "WebApps_ListHybridConnectionKeysSlot", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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" @@ -8169,28 +9151,21 @@ { "name": "name", "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "namespaceName", - "in": "path", - "description": "The namespace for this hybrid connection", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "relayName", + "name": "domainOwnershipIdentifierName", "in": "path", - "description": "The relay name for this hybrid connection", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "The name of the slot for the web app.", + "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" }, @@ -8203,22 +9178,25 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HybridConnectionKey" - } + "description": "Succesfully deleted domain ownership identifier." + }, + "204": { + "description": "Domain ownership identifider does not exist." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays": { - "get": { + }, + "patch": { "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_ListHybridConnectionsSlot", + "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", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -8232,14 +9210,30 @@ { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "domainOwnershipIdentifierName", + "in": "path", + "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, + { + "name": "domainOwnershipIdentifier", + "in": "body", + "description": "A JSON representation of the domain ownership properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Identifier" + } + }, { "name": "slot", "in": "path", - "description": "The name of the slot for the web app.", + "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" }, @@ -8254,20 +9248,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridConnection" + "$ref": "#/definitions/Identifier" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], - "summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).", - "description": "Gets hybrid connections configured for an app (or deployment slot, if specified).", - "operationId": "WebApps_ListRelayServiceConnectionsSlot", + "summary": "Get the status of the last MSDeploy operation.", + "description": "Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployStatusSlot", "produces": [ "application/json", "text/json", @@ -8281,14 +9275,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 hybrid connections for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8303,20 +9297,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/MSDeployStatus" } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets a hybrid connection configuration by its name.", - "description": "Gets a hybrid connection configuration by its name.", - "operationId": "WebApps_GetRelayServiceConnectionSlot", + "summary": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateMSDeployOperationSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -8330,23 +9327,25 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "entityName", + "name": "slot", "in": "path", - "description": "Name of the hybrid connection.", + "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 will get a hybrid connection for the production slot.", + "name": "MSDeploy", + "in": "body", + "description": "Details of MSDeploy operation", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/MSDeploy" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -8356,26 +9355,27 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Deployment is scheduled.", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/MSDeployStatus" } + }, + "409": { + "description": "Another deployment is in progress." } - } - }, - "put": { + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": { + "get": { "tags": [ "WebApps" ], - "summary": "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_CreateOrUpdateRelayServiceConnectionSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetMSDeployLogSlot", "produces": [ "application/json", "text/json", @@ -8389,30 +9389,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "Name of the hybrid connection configuration.", + "description": "Name of web app.", "required": true, "type": "string" }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "Details of the hybrid connection configuration.", - "required": true, - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8425,20 +9409,29 @@ ], "responses": { "200": { - "description": "OK", + "description": "MSDeploy log returned.", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/MSDeployLog" } + }, + "404": { + "description": "MSDeploy log not found." } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes a relay service connection by its name.", - "description": "Deletes a relay service connection by its name.", - "operationId": "WebApps_DeleteRelayServiceConnectionSlot", + "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", + "produces": [ + "application/json", + "text/json" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8446,21 +9439,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "Name of the hybrid connection configuration.", + "description": "Site name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection 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" }, @@ -8473,25 +9459,28 @@ ], "responses": { "200": { - "description": "Succesfully deleted relay service connection." + "description": "Function information returned.", + "schema": { + "$ref": "#/definitions/FunctionEnvelopeCollection" + } }, "404": { - "description": "Relay service connection does not exist." + "description": "Function with an ID of {functionName} is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": { + "get": { "tags": [ "WebApps" ], - "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", - "description": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", - "operationId": "WebApps_UpdateRelayServiceConnectionSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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", "produces": [ "application/json", "text/json", @@ -8505,30 +9494,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "Name of the hybrid connection configuration.", + "description": "Name of web app.", "required": true, "type": "string" }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "Details of the hybrid connection configuration.", - "required": true, - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -8543,23 +9516,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "type": "string" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets all scale-out instances of an app.", - "description": "Gets all scale-out instances of an app.", - "operationId": "WebApps_ListInstanceIdentifiersSlot", + "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", "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -8568,14 +9543,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "functionName", + "in": "path", + "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.", + "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" }, @@ -8588,28 +9570,33 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function information returned.", "schema": { - "$ref": "#/definitions/WebAppInstanceCollection" + "$ref": "#/definitions/FunctionEnvelope" } + }, + "404": { + "description": "Function with an name of {functionName} is not running." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.", - "description": "List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.", - "operationId": "WebApps_ListInstanceDeploymentsSlot", + "summary": "Create function for web site, or a deployment slot.", + "description": "Create function for web site, or a deployment slot.", + "operationId": "WebApps_CreateInstanceFunctionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -8618,24 +9605,33 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "slot", + "name": "functionName", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "description": "Function name.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "slot", "in": "path", - "description": "The 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 deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, + { + "name": "function_envelope", + "in": "body", + "description": "Function details.", + "required": true, + "schema": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -8644,32 +9640,22 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Function created.", "schema": { - "$ref": "#/definitions/DeploymentCollection" + "$ref": "#/definitions/FunctionEnvelope" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}": { - "get": { + "x-ms-long-running-operation": true + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_GetInstanceDeploymentSlot", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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" @@ -8677,28 +9663,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "id", + "name": "functionName", "in": "path", - "description": "Deployment ID.", + "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.", - "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 deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, @@ -8710,26 +9689,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } + "204": { + "description": "Function deleted." + }, + "404": { + "description": "Function does not exist." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": { + "post": { "tags": [ "WebApps" ], - "summary": "Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_CreateInstanceDeploymentSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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", "produces": [ "application/json", "text/json", @@ -8743,40 +9719,24 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "id", + "name": "functionName", "in": "path", - "description": "ID of an existing deployment.", + "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.", - "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 deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, - { - "name": "deployment", - "in": "body", - "description": "Deployment details.", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -8786,20 +9746,26 @@ ], "responses": { "200": { - "description": "OK", + "description": "Function secrets returned.", "schema": { - "$ref": "#/definitions/Deployment" + "$ref": "#/definitions/FunctionSecrets" } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": { + "get": { "tags": [ "WebApps" ], - "summary": "Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "description": "Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.", - "operationId": "WebApps_DeleteInstanceDeploymentSlot", + "summary": "Get hostname bindings for an app or a deployment slot.", + "description": "Get hostname bindings for an app or a deployment slot.", + "operationId": "WebApps_ListHostNameBindingsSlot", + "produces": [ + "application/json", + "text/json" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8811,24 +9777,10 @@ "required": true, "type": "string" }, - { - "name": "id", - "in": "path", - "description": "Deployment ID.", - "required": true, - "type": "string" - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", - "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 deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.", "required": true, "type": "string" }, @@ -8841,22 +9793,25 @@ ], "responses": { "200": { - "description": "Succesfully deleted deployment" - }, - "204": { - "description": "Deployment does not exist" + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBindingCollection" + } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": { "get": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension as pass-through API", - "description": "Invoke the MSDeploy web app extension as pass-through API", - "operationId": "WebApps_GetInstanceMsDeployStatusSlot", + "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_GetHostNameBindingSlot", "produces": [ "application/json", "text/json", @@ -8870,21 +9825,21 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "hostName", "in": "path", - "description": "Id of web app instance", + "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, @@ -8899,7 +9854,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/HostNameBinding" } } } @@ -8908,9 +9863,9 @@ "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy web app extension as pass-through API", - "description": "Invoke the MSDeploy web app extension as pass-through API", - "operationId": "WebApps_CreateInstanceMSDeployOperationSlot", + "summary": "Creates a hostname binding for an app.", + "description": "Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdateHostNameBindingSlot", "consumes": [ "application/json", "text/json", @@ -8929,33 +9884,33 @@ { "name": "name", "in": "path", - "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.", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "hostName", "in": "path", - "description": "Id of web app instance", + "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, { - "name": "MSDeploy", + "name": "hostNameBinding", "in": "body", - "description": "Details of MSDeploy operation", + "description": "Binding details. This is the JSON representation of a HostNameBinding object.", "required": true, "schema": { - "$ref": "#/definitions/MSDeploy" + "$ref": "#/definitions/HostNameBinding" } }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -8964,33 +9919,21 @@ } ], "responses": { - "201": { - "description": "Deployment is scheduled", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/MSDeployStatus" + "$ref": "#/definitions/HostNameBinding" } - }, - "409": { - "description": "Another deployment is in progress" } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log": { - "get": { + } + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Invoke the MSDeploy Log web app extension as pass-through API", - "description": "Invoke the MSDeploy Log web app extension as pass-through API", - "operationId": "WebApps_GetInstanceMSDeployLogSlot", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "summary": "Deletes a hostname binding for an app.", + "description": "Deletes a hostname binding for an app.", + "operationId": "WebApps_DeleteHostNameBindingSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -8998,21 +9941,21 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, { - "name": "instanceId", + "name": "hostName", "in": "path", - "description": "Id of web app instance", + "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, @@ -9025,22 +9968,22 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MSDeployLog" - } + "description": "Succesfully deleted hostname binding." + }, + "204": { + "description": "Hostname binding does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { + "get": { "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_IsCloneableSlot", + "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_GetHybridConnectionSlot", "produces": [ "application/json", "text/json", @@ -9054,14 +9997,28 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. By default, this API returns information on the production slot.", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -9076,23 +10033,28 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteCloneability" + "$ref": "#/definitions/HybridConnection" } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions": { - "get": { + }, + "put": { "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_ListMetricDefinitionsSlot", + "summary": "Creates a new Hybrid Connection using a Service Bus relay.", + "description": "Creates a new Hybrid Connection using a Service Bus relay.", + "operationId": "WebApps_CreateOrUpdateHybridConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -9101,14 +10063,37 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the web app.", "required": true, "type": "string" }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the hybrid connection.", + "required": true, + "schema": { + "$ref": "#/definitions/HybridConnection" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get metric definitions of the production slot.", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -9123,27 +10108,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResourceMetricDefinitionCollection" + "$ref": "#/definitions/HybridConnection" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics": { - "get": { + }, + "delete": { "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_ListMetricsSlot", - "produces": [ - "application/json", - "text/json" - ], + "summary": "Removes a Hybrid Connection from this site.", + "description": "Removes a Hybrid Connection from this site.", + "operationId": "WebApps_DeleteHybridConnectionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9151,28 +10127,29 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "name": "slot", + "name": "namespaceName", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get metrics of the production slot.", + "description": "The namespace for this hybrid connection.", "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": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", + "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]'.", - "x-ms-skip-url-encoding": true, + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, "type": "string" }, { @@ -9184,25 +10161,25 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResourceMetricCollection" - } + "description": "Succesfully deleted hybrid connection." + }, + "404": { + "description": "Hybrid connection does not exist." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status": { - "get": { + }, + "patch": { "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_GetMigrateMySqlStatusSlot", + "summary": "Creates a new Hybrid Connection using a Service Bus relay.", + "description": "Creates a new Hybrid Connection using a Service Bus relay.", + "operationId": "WebApps_UpdateHybridConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -9216,14 +10193,37 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "namespaceName", + "in": "path", + "description": "The namespace for this hybrid connection.", + "required": true, + "type": "string" + }, + { + "name": "relayName", + "in": "path", + "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the hybrid connection.", + "required": true, + "schema": { + "$ref": "#/definitions/HybridConnection" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -9238,20 +10238,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MigrateMySqlStatus" + "$ref": "#/definitions/HybridConnection" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { + "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_ListNetworkFeaturesSlot", + "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_ListHybridConnectionKeysSlot", "produces": [ "application/json", "text/json", @@ -9265,21 +10265,28 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the web app.", "required": true, "type": "string" }, { - "name": "view", + "name": "namespaceName", "in": "path", - "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "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": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -9294,23 +10301,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/NetworkFeatures" + "$ref": "#/definitions/HybridConnectionKey" } - }, - "404": { - "description": "The requested view does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays": { + "get": { "tags": [ "WebApps" ], - "summary": "Start capturing network packets for the site.", - "description": "Start capturing network packets for the site.", - "operationId": "WebApps_StartWebSiteNetworkTraceSlot", + "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_ListHybridConnectionsSlot", "produces": [ "application/json", "text/json", @@ -9328,33 +10332,13 @@ "required": true, "type": "string" }, - { - "name": "durationInSeconds", - "in": "query", - "description": "The duration to keep capturing in seconds.", - "type": "integer", - "format": "int32" - }, { "name": "slot", "in": "path", - "description": "The name of the slot for this web app.", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, - { - "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" }, @@ -9366,20 +10350,20 @@ "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/HybridConnection" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": { + "get": { "tags": [ "WebApps" ], - "summary": "Stop ongoing capturing network packets for the site.", - "description": "Stop ongoing capturing network packets for the site.", - "operationId": "WebApps_StopWebSiteNetworkTraceSlot", + "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_ListRelayServiceConnectionsSlot", "produces": [ "application/json", "text/json", @@ -9393,14 +10377,14 @@ { "name": "name", "in": "path", - "description": "The name of the web app.", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "The name of the slot for this web app.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot.", "required": true, "type": "string" }, @@ -9415,20 +10399,26 @@ "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Generates a new publishing password for an app (or deployment slot, if specified).", - "description": "Generates a new publishing password for an app (or deployment slot, if specified).", - "operationId": "WebApps_GenerateNewSitePublishingPasswordSlot", + "summary": "Gets a hybrid connection configuration by its name.", + "description": "Gets a hybrid connection configuration by its name.", + "operationId": "WebApps_GetRelayServiceConnectionSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9440,10 +10430,17 @@ "required": true, "type": "string" }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection.", + "required": true, + "type": "string" + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.", "required": true, "type": "string" }, @@ -9455,23 +10452,31 @@ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters": { - "get": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Gets perfmon counters for web app.", - "description": "Gets perfmon counters for web app.", - "operationId": "WebApps_ListPerfMonCountersSlot", + "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_CreateOrUpdateRelayServiceConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -9480,22 +10485,31 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of the app.", "required": true, "type": "string" }, { - "name": "slot", + "name": "entityName", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the hybrid connection configuration.", "required": true, "type": "string" }, { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "x-ms-skip-url-encoding": true, + "name": "connectionEnvelope", + "in": "body", + "description": "Details of the hybrid connection configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.", + "required": true, "type": "string" }, { @@ -9509,23 +10523,71 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PerfMonCounterCollection" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging": { - "get": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets web app's event logs.", - "description": "Gets web app's event logs.", - "operationId": "WebApps_GetSitePhpErrorLogFlagSlot", + "summary": "Deletes a relay service connection by its name.", + "description": "Deletes a relay service connection by its name.", + "operationId": "WebApps_DeleteRelayServiceConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "Name of the hybrid connection configuration.", + "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 hybrid connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted relay service connection." + }, + "404": { + "description": "Relay service connection does not exist." + } + } + }, + "patch": { + "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_UpdateRelayServiceConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -9539,14 +10601,30 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "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" + } + }, { "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 create or update a hybrid connection for the production slot.", "required": true, "type": "string" }, @@ -9561,25 +10639,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SitePhpErrorLogFlag" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the premier add-ons of an app.", - "description": "Gets the premier add-ons of an app.", - "operationId": "WebApps_ListPremierAddOnsSlot", + "summary": "Gets all scale-out instances of an app.", + "description": "Gets all scale-out instances of an app.", + "operationId": "WebApps_ListInstanceIdentifiersSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -9595,7 +10671,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.", "required": true, "type": "string" }, @@ -9610,20 +10686,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/WebAppInstanceCollection" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a named add-on of an app.", - "description": "Gets a named add-on of an app.", - "operationId": "WebApps_GetPremierAddOnSlot", + "summary": "Get the status of the last MSDeploy operation.", + "description": "Get the status of the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMsDeployStatusSlot", "produces": [ "application/json", "text/json", @@ -9637,21 +10716,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "premierAddOnName", + "name": "slot", "in": "path", - "description": "Add-on name.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, { - "name": "slot", + "name": "instanceId", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.", + "description": "ID of web app instance.", "required": true, "type": "string" }, @@ -9666,7 +10745,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/MSDeployStatus" } } } @@ -9675,9 +10754,9 @@ "tags": [ "WebApps" ], - "summary": "Updates a named add-on of an app.", - "description": "Updates a named add-on of an app.", - "operationId": "WebApps_AddPremierAddOnSlot", + "summary": "Invoke the MSDeploy web app extension.", + "description": "Invoke the MSDeploy web app extension.", + "operationId": "WebApps_CreateInstanceMSDeployOperationSlot", "consumes": [ "application/json", "text/json", @@ -9696,33 +10775,33 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "premierAddOnName", + "name": "slot", "in": "path", - "description": "Add-on name.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, { - "name": "premierAddOn", + "name": "instanceId", + "in": "path", + "description": "ID of web app instance.", + "required": true, + "type": "string" + }, + { + "name": "MSDeploy", "in": "body", - "description": "A JSON representation of the edited premier add-on.", + "description": "Details of MSDeploy operation", "required": true, "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/MSDeploy" } }, - { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -9731,21 +10810,33 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Deployment is scheduled.", "schema": { - "$ref": "#/definitions/PremierAddOn" + "$ref": "#/definitions/MSDeployStatus" } + }, + "409": { + "description": "Another deployment is in progress." } - } - }, - "delete": { + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log": { + "get": { "tags": [ "WebApps" ], - "summary": "Delete a premier add-on from an app.", - "description": "Delete a premier add-on from an app.", - "operationId": "WebApps_DeletePremierAddOnSlot", + "summary": "Get the MSDeploy Log for the last MSDeploy operation.", + "description": "Get the MSDeploy Log for the last MSDeploy operation.", + "operationId": "WebApps_GetInstanceMSDeployLogSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9753,21 +10844,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, { - "name": "premierAddOnName", + "name": "slot", "in": "path", - "description": "Add-on name.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, { - "name": "slot", + "name": "instanceId", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot.", + "description": "ID of web app instance.", "required": true, "type": "string" }, @@ -9780,19 +10871,25 @@ ], "responses": { "200": { - "description": "Succesfully deleted premier add-on." + "description": "MSDeploy log returned.", + "schema": { + "$ref": "#/definitions/MSDeployLog" + } + }, + "404": { + "description": "MSDeploy log not found." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes": { "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_ListPublicCertificatesSlot", + "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_ListInstanceProcessesSlot", "produces": [ "application/json", "text/json" @@ -9804,14 +10901,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings 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" + }, + { + "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" }, @@ -9824,10 +10928,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process terminated.", "schema": { - "$ref": "#/definitions/PublicCertificateCollection" + "$ref": "#/definitions/ProcessInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { @@ -9835,14 +10942,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}": { "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_GetPublicCertificateSlot", + "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_GetInstanceProcessSlot", "produces": [ "application/json", "text/json", @@ -9856,21 +10963,28 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API the named binding 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" }, { - "name": "publicCertificateName", + "name": "instanceId", "in": "path", - "description": "Public CertificateName", + "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" }, @@ -9883,31 +10997,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process information returned.", "schema": { - "$ref": "#/definitions/PublicCertificate" + "$ref": "#/definitions/ProcessInfo" } + }, + "404": { + "description": "Process with the specified ID is not running." } } }, - "put": { + "delete": { "tags": [ "WebApps" ], - "summary": "Creates a hostname binding for an app.", - "description": "Creates a hostname binding for an app.", - "operationId": "WebApps_CreateOrUpdatePublicCertificateSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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_DeleteInstanceProcessSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9915,30 +11021,28 @@ { "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.", + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, - "schema": { - "$ref": "#/definitions/PublicCertificate" - } + "type": "string" }, { - "name": "slot", + "name": "instanceId", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.", + "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" }, @@ -9950,21 +11054,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PublicCertificate" - } + "204": { + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running." } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes a hostname binding for an app.", - "description": "Deletes a hostname binding for an app.", - "operationId": "WebApps_DeletePublicCertificateSlot", + "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_GetInstanceProcessDumpSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -9972,21 +11078,28 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, { - "name": "publicCertificateName", + "name": "instanceId", "in": "path", - "description": "Public Certificate Name.", + "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" }, @@ -9999,34 +11112,28 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding" + "description": "OK", + "schema": { + "type": "file" + } }, - "204": { - "description": "Hostname binding does not exist" + "404": { + "description": "Process with the specified ID is not running." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules": { + "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_ListPublishingProfileXmlWithSecretsSlot", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], + "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_ListInstanceProcessModulesSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -10035,23 +11142,28 @@ { "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" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing profile 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" + }, + { + "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" }, @@ -10064,26 +11176,33 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "type": "file" + "$ref": "#/definitions/ProcessModuleInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{base_address}": { + "get": { "tags": [ "WebApps" ], - "summary": "Recovers a web app to a previous snapshot.", - "description": "Recovers a web app to a previous snapshot.", - "operationId": "WebApps_RecoverSlot", - "consumes": [ + "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_GetInstanceProcessModuleSlot", + "produces": [ "application/json", "text/json", - "application/x-www-form-urlencoded" + "application/xml", + "text/xml" ], "parameters": [ { @@ -10092,23 +11211,41 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "recoveryEntity", - "in": "body", - "description": "Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "name": "processId", + "in": "path", + "description": "PID.", "required": true, - "schema": { - "$ref": "#/definitions/SnapshotRecoveryRequest" - } + "type": "string" + }, + { + "name": "baseAddress", + "in": "query", + "description": "Module base address.", + "required": true, + "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "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" + }, + { + "name": "base_address", + "in": "path", "required": true, "type": "string" }, @@ -10120,21 +11257,30 @@ } ], "responses": { - "202": { - "description": "Recovery operation started" + "200": { + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "404": { + "description": "Process with the specified ID is not running, or a module with the specified base_address was not found." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads": { + "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_ResetSlotConfigurationSlot", + "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_ListInstanceProcessThreadsSlot", + "produces": [ + "application/json", + "text/json" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10142,19 +11288,33 @@ { "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": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API resets configuration settings 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" }, { - "$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" @@ -10162,19 +11322,34 @@ ], "responses": { "200": { - "description": "OK" + "description": "Thread information returned.", + "schema": { + "$ref": "#/definitions/ProcessThreadInfoCollection" + } + }, + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads/{threadId}": { + "get": { "tags": [ "WebApps" ], - "summary": "Restarts an app (or deployment slot, if specified).", - "description": "Restarts an app (or deployment slot, if specified).", - "operationId": "WebApps_RestartSlot", + "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_GetInstanceProcessThreadSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10182,28 +11357,37 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "slot", + "name": "processId", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will restart the production slot.", + "description": "PID.", "required": true, "type": "string" }, { - "name": "softRestart", - "in": "query", - "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", - "type": "boolean" + "name": "threadId", + "in": "path", + "description": "TID.", + "required": true, + "type": "string" }, { - "name": "synchronous", - "in": "query", - "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", - "type": "boolean" + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "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" @@ -10214,29 +11398,30 @@ ], "responses": { "200": { - "description": "Successfully restarted app." + "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}/slots/{slot}/slotsdiffs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": { "post": { "tags": [ "WebApps" ], - "summary": "Get the difference in configuration settings between two web app slots.", - "description": "Get the difference in configuration settings between two web app slots.", - "operationId": "WebApps_ListSlotDifferencesSlot", - "consumes": [ + "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_IsCloneableSlot", + "produces": [ "application/json", "text/json", "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json" + "text/xml" ], "parameters": [ { @@ -10249,19 +11434,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. By default, this API returns information on the production slot.", "required": true, "type": "string" }, @@ -10274,31 +11450,27 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK.", "schema": { - "$ref": "#/definitions/SlotDifferenceCollection" + "$ref": "#/definitions/SiteCloneability" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus": { "post": { "tags": [ "WebApps" ], - "summary": "Swaps two deployment slots of an app.", - "description": "Swaps two deployment slots of an app.", - "operationId": "WebApps_SwapSlotSlot", - "consumes": [ + "summary": "This is to allow calling via powershell and ARM template.", + "description": "This is to allow calling via powershell and ARM template.", + "operationId": "WebApps_ListSyncFunctionTriggersSlot", + "produces": [ "application/json", "text/json", "application/xml", - "text/xml", - "application/x-www-form-urlencoded" + "text/xml" ], "parameters": [ { @@ -10311,19 +11483,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 restore a backup of the production slot.", "required": true, "type": "string" }, @@ -10336,23 +11499,22 @@ ], "responses": { "200": { - "description": "OK" - }, - "202": { - "description": "Operation is in progress" + "description": "OK", + "schema": { + "$ref": "#/definitions/FunctionSecrets" + } } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions": { "get": { "tags": [ "WebApps" ], - "summary": "Returns all Snapshots to the user.", - "description": "Returns all Snapshots to the user.", - "operationId": "WebApps_ListSnapshotsSlot", + "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_ListMetricDefinitionsSlot", "produces": [ "application/json", "text/json" @@ -10364,14 +11526,14 @@ { "name": "name", "in": "path", - "description": "Website Name", + "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Website Slot", + "description": "Name of the deployment slot. If a slot is not specified, the API will get metric definitions of the production slot.", "required": true, "type": "string" }, @@ -10386,7 +11548,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SnapshotCollection" + "$ref": "#/definitions/ResourceMetricDefinitionCollection" } } }, @@ -10395,19 +11557,17 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the source control configuration of an app.", - "description": "Gets the source control configuration of an app.", - "operationId": "WebApps_GetSourceControlSlot", + "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_ListMetricsSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -10423,10 +11583,23 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get metrics of the production slot.", "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]'.", + "x-ms-skip-url-encoding": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -10438,23 +11611,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/ResourceMetricCollection" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates the source control configuration of an app.", - "description": "Updates the source control configuration of an app.", - "operationId": "WebApps_CreateOrUpdateSourceControlSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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_GetMigrateMySqlStatusSlot", "produces": [ "application/json", "text/json", @@ -10468,23 +11641,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", "required": true, "type": "string" }, - { - "name": "siteSourceControl", - "in": "body", - "description": "JSON representation of a SiteSourceControl object. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.", + "description": "Name of the deployment slot.", "required": true, "type": "string" }, @@ -10497,27 +11661,28 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - }, - "201": { - "description": "Create or update source control for web app in progress.", + "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/MigrateMySqlStatus" } } - }, - "x-ms-long-running-operation": true - }, - "delete": { + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes the source control configuration of an app.", - "description": "Deletes the source control configuration of an app.", - "operationId": "WebApps_DeleteSourceControlSlot", + "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_ListNetworkFeaturesSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10529,10 +11694,17 @@ "required": true, "type": "string" }, + { + "name": "view", + "in": "path", + "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "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 source control configuration for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.", "required": true, "type": "string" }, @@ -10545,25 +11717,31 @@ ], "responses": { "200": { - "description": "Succesfully deleted source control for web app." - }, - "202": { - "description": "Source control delete operation in progress." + "description": "OK.", + "schema": { + "$ref": "#/definitions/NetworkFeatures" + } }, "404": { - "description": "Source control does not exist." + "description": "The requested view does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start": { "post": { "tags": [ "WebApps" ], - "summary": "Starts an app (or deployment slot, if specified).", - "description": "Starts an app (or deployment slot, if specified).", - "operationId": "WebApps_StartSlot", + "summary": "Start capturing network packets for the site.", + "description": "Start capturing network packets for the site.", + "operationId": "WebApps_StartWebSiteNetworkTraceSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10571,16 +11749,36 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the 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 start the production slot.", - "required": true, - "type": "string" + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "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" @@ -10591,19 +11789,28 @@ ], "responses": { "200": { - "description": "Successfully started app." + "description": "OK.", + "schema": { + "type": "string" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop": { "post": { "tags": [ "WebApps" ], - "summary": "Stops an app (or deployment slot, if specified).", - "description": "Stops an app (or deployment slot, if specified).", - "operationId": "WebApps_StopSlot", + "summary": "Stop ongoing capturing network packets for the site.", + "description": "Stop ongoing capturing network packets for the site.", + "operationId": "WebApps_StopWebSiteNetworkTraceSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10611,14 +11818,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "The name of the 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 stop the production slot.", + "description": "The name of the slot for this web app.", "required": true, "type": "string" }, @@ -10631,19 +11838,22 @@ ], "responses": { "200": { - "description": "Successfully stopped app." + "description": "OK.", + "schema": { + "type": "string" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { "post": { "tags": [ "WebApps" ], - "summary": "Sync web app repository.", - "description": "Sync web app repository.", - "operationId": "WebApps_SyncRepositorySlot", + "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_GenerateNewSitePublishingPasswordSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10651,14 +11861,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. If a slot is not specified, the API generate a new publishing password for the production slot.", "required": true, "type": "string" }, @@ -10670,20 +11880,24 @@ } ], "responses": { - "200": { - "description": "Successfully sync sourcecontrol." + "204": { + "description": "No Content" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters": { + "get": { "tags": [ "WebApps" ], - "summary": "Syncs function trigger metadata to the scale controller", - "description": "Syncs function trigger metadata to the scale controller", - "operationId": "WebApps_SyncFunctionTriggersSlot", + "summary": "Gets perfmon counters for web app.", + "description": "Gets perfmon counters for web app.", + "operationId": "WebApps_ListPerfMonCountersSlot", + "produces": [ + "application/json", + "text/json" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10691,17 +11905,24 @@ { "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 restore a backup of the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "x-ms-skip-url-encoding": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -10710,23 +11931,31 @@ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PerfMonCounterCollection" + } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the quota usage information of an app (or deployment slot, if specified).", - "description": "Gets the quota usage information of an app (or deployment slot, if specified).", - "operationId": "WebApps_ListUsagesSlot", + "summary": "Gets web app's event logs.", + "description": "Gets web app's event logs.", + "operationId": "WebApps_GetSitePhpErrorLogFlagSlot", "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -10735,24 +11964,17 @@ { "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 quota information of the production slot.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, - { - "name": "$filter", - "in": "query", - "description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "x-ms-skip-url-encoding": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -10764,23 +11986,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CsmUsageQuotaCollection" + "$ref": "#/definitions/SitePhpErrorLogFlag" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the virtual networks the app (or deployment slot) is connected to.", - "description": "Gets the virtual networks the app (or deployment slot) is connected to.", - "operationId": "WebApps_ListVnetConnectionsSlot", + "summary": "Gets the premier add-ons of an app.", + "description": "Gets the premier add-ons of an app.", + "operationId": "WebApps_ListPremierAddOnsSlot", "produces": [ "application/json", "text/json", @@ -10801,7 +12020,7 @@ { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot.", "required": true, "type": "string" }, @@ -10816,23 +12035,20 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetInfo" - } + "$ref": "#/definitions/PremierAddOn" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a virtual network the app (or deployment slot) is connected to by name.", - "description": "Gets a virtual network the app (or deployment slot) is connected to by name.", - "operationId": "WebApps_GetVnetConnectionSlot", + "summary": "Gets a named add-on of an app.", + "description": "Gets a named add-on of an app.", + "operationId": "WebApps_GetPremierAddOnSlot", "produces": [ "application/json", "text/json", @@ -10851,16 +12067,16 @@ "type": "string" }, { - "name": "vnetName", + "name": "premierAddOnName", "in": "path", - "description": "Name of the virtual network.", + "description": "Add-on name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.", "required": true, "type": "string" }, @@ -10875,7 +12091,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/PremierAddOn" } } } @@ -10884,9 +12100,9 @@ "tags": [ "WebApps" ], - "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", - "description": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", - "operationId": "WebApps_CreateOrUpdateVnetConnectionSlot", + "summary": "Updates a named add-on of an app.", + "description": "Updates a named add-on of an app.", + "operationId": "WebApps_AddPremierAddOnSlot", "consumes": [ "application/json", "text/json", @@ -10910,25 +12126,25 @@ "type": "string" }, { - "name": "vnetName", + "name": "premierAddOnName", "in": "path", - "description": "Name of an existing Virtual Network.", + "description": "Add-on name.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", + "name": "premierAddOn", "in": "body", - "description": "Properties of the Virtual Network connection. See example.", + "description": "A JSON representation of the edited premier add-on.", "required": true, "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/PremierAddOn" } }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.", "required": true, "type": "string" }, @@ -10943,7 +12159,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/PremierAddOn" } } } @@ -10952,9 +12168,9 @@ "tags": [ "WebApps" ], - "summary": "Deletes a connection from an app (or deployment slot to a named virtual network.", - "description": "Deletes a connection from an app (or deployment slot to a named virtual network.", - "operationId": "WebApps_DeleteVnetConnectionSlot", + "summary": "Delete a premier add-on from an app.", + "description": "Delete a premier add-on from an app.", + "operationId": "WebApps_DeletePremierAddOnSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -10967,16 +12183,16 @@ "type": "string" }, { - "name": "vnetName", + "name": "premierAddOnName", "in": "path", - "description": "Name of the virtual network.", + "description": "Add-on 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 connection for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot.", "required": true, "type": "string" }, @@ -10989,30 +12205,22 @@ ], "responses": { "200": { - "description": "Succesfully deleted virtual network." - }, - "404": { - "description": "Virtual network does not exist." + "description": "Succesfully deleted premier add-on." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes": { + "get": { "tags": [ "WebApps" ], - "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", - "description": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", - "operationId": "WebApps_UpdateVnetConnectionSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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_ListProcessesSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -11021,30 +12229,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of an existing Virtual Network.", + "description": "Site name.", "required": true, "type": "string" }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "Properties of the Virtual Network connection. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetInfo" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections 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" }, @@ -11057,22 +12249,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process terminated.", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/ProcessInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets an app's Virtual Network gateway.", - "description": "Gets an app's Virtual Network gateway.", - "operationId": "WebApps_GetVnetConnectionGatewaySlot", + "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_GetProcessSlot", "produces": [ "application/json", "text/json", @@ -11086,28 +12284,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of the Virtual Network.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "gatewayName", + "name": "processId", "in": "path", - "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "description": "PID.", "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 gateway for the production slot's Virtual Network.", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, @@ -11120,34 +12311,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Process information returned.", "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/ProcessInfo" } }, "404": { - "description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently." + "description": "Process with the specified ID is not running." } } }, - "put": { + "delete": { "tags": [ "WebApps" ], - "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", - "description": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", - "operationId": "WebApps_CreateOrUpdateVnetConnectionGatewaySlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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_DeleteProcessSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11155,37 +12335,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of the Virtual Network.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "gatewayName", + "name": "processId", "in": "path", - "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "description": "PID.", "required": true, "type": "string" }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties to update this gateway with.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, @@ -11197,32 +12361,23 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetGateway" - } + "204": { + "description": "Process terminated." + }, + "404": { + "description": "Process with the specified ID is not running." } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump": { + "get": { "tags": [ "WebApps" ], - "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", - "description": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", - "operationId": "WebApps_UpdateVnetConnectionGatewaySlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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_GetProcessDumpSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11230,37 +12385,21 @@ { "name": "name", "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of the Virtual Network.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "gatewayName", + "name": "processId", "in": "path", - "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "description": "PID.", "required": true, "type": "string" }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties to update this gateway with.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } - }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, @@ -11275,27 +12414,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetGateway" + "type": "file" } + }, + "404": { + "description": "Process with the specified ID is not running." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules": { + "get": { "tags": [ "WebApps" ], - "summary": "Get the difference in configuration settings between two web app slots.", - "description": "Get the difference in configuration settings between two web app slots.", - "operationId": "WebApps_ListSlotDifferencesFromProduction", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], + "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_ListProcessModulesSlot", "produces": [ "application/json", "text/json" @@ -11307,18 +12442,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "slotSwapEntity", - "in": "body", - "description": "JSON object that contains the target slot name. See example.", + "name": "processId", + "in": "path", + "description": "PID.", "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -11329,10 +12469,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Module information returned.", "schema": { - "$ref": "#/definitions/SlotDifferenceCollection" + "$ref": "#/definitions/ProcessModuleInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { @@ -11340,20 +12483,19 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{base_address}": { + "get": { "tags": [ "WebApps" ], - "summary": "Swaps two deployment slots of an app.", - "description": "Swaps two deployment slots of an app.", - "operationId": "WebApps_SwapSlotWithProduction", - "consumes": [ + "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_GetProcessModuleSlot", + "produces": [ "application/json", "text/json", "application/xml", - "text/xml", - "application/x-www-form-urlencoded" + "text/xml" ], "parameters": [ { @@ -11362,18 +12504,36 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "slotSwapEntity", - "in": "body", - "description": "JSON object that contains the target slot name. See example.", + "name": "processId", + "in": "path", + "description": "PID.", "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } + "type": "string" + }, + { + "name": "baseAddress", + "in": "query", + "description": "Module base address.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "base_address", + "in": "path", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -11384,23 +12544,25 @@ ], "responses": { "200": { - "description": "OK" + "description": "Module information returned.", + "schema": { + "$ref": "#/definitions/ProcessModuleInfo" + } }, - "202": { - "description": "Operation is in progress" + "404": { + "description": "Process with the specified ID is not running, or a module with the specified base_address was not found." } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads": { "get": { "tags": [ "WebApps" ], - "summary": "Returns all Snapshots to the user.", - "description": "Returns all Snapshots to the user.", - "operationId": "WebApps_ListSnapshots", + "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_ListProcessThreadsSlot", "produces": [ "application/json", "text/json" @@ -11412,7 +12574,21 @@ { "name": "name", "in": "path", - "description": "Website Name", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, @@ -11425,10 +12601,13 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "#/definitions/SnapshotCollection" + "$ref": "#/definitions/ProcessThreadInfoCollection" } + }, + "404": { + "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { @@ -11436,14 +12615,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads/{threadId}": { "get": { "tags": [ "WebApps" ], - "summary": "Gets the source control configuration of an app.", - "description": "Gets the source control configuration of an app.", - "operationId": "WebApps_GetSourceControl", + "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_GetProcessThreadSlot", "produces": [ "application/json", "text/json", @@ -11457,7 +12636,28 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "processId", + "in": "path", + "description": "PID.", + "required": true, + "type": "string" + }, + { + "name": "threadId", + "in": "path", + "description": "TID.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, @@ -11470,30 +12670,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "Thread information returned.", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$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." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates": { + "get": { "tags": [ "WebApps" ], - "summary": "Updates the source control configuration of an app.", - "description": "Updates the source control configuration of an app.", - "operationId": "WebApps_CreateOrUpdateSourceControl", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Get public certificates for an app or a deployment slot.", + "description": "Get public certificates for an app or a deployment slot.", + "operationId": "WebApps_ListPublicCertificatesSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -11507,13 +12705,11 @@ "type": "string" }, { - "name": "siteSourceControl", - "in": "body", - "description": "JSON representation of a SiteSourceControl object. See example.", + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.", "required": true, - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -11524,27 +12720,31 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - }, - "201": { - "description": "Create or update source control for web app in progress.", + "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/PublicCertificateCollection" } } }, - "x-ms-long-running-operation": true - }, - "delete": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Deletes the source control configuration of an app.", - "description": "Deletes the source control configuration of an app.", - "operationId": "WebApps_DeleteSourceControl", + "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_GetPublicCertificateSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11556,6 +12756,20 @@ "required": true, "type": "string" }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -11565,25 +12779,31 @@ ], "responses": { "200": { - "description": "Succesfully deleted source control for web app." - }, - "202": { - "description": "Source control delete operation in progress." - }, - "404": { - "description": "Source control does not exist." + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": { - "post": { + }, + "put": { "tags": [ "WebApps" ], - "summary": "Starts an app (or deployment slot, if specified).", - "description": "Starts an app (or deployment slot, if specified).", - "operationId": "WebApps_Start", + "summary": "Creates a hostname binding for an app.", + "description": "Creates a hostname binding for an app.", + "operationId": "WebApps_CreateOrUpdatePublicCertificateSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11595,6 +12815,29 @@ "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" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -11604,19 +12847,20 @@ ], "responses": { "200": { - "description": "Successfully started app." + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicCertificate" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": { - "post": { + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Stops an app (or deployment slot, if specified).", - "description": "Stops an app (or deployment slot, if specified).", - "operationId": "WebApps_Stop", + "summary": "Deletes a hostname binding for an app.", + "description": "Deletes a hostname binding for an app.", + "operationId": "WebApps_DeletePublicCertificateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11628,6 +12872,20 @@ "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.", + "required": true, + "type": "string" + }, + { + "name": "publicCertificateName", + "in": "path", + "description": "Public certificate name.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -11637,19 +12895,35 @@ ], "responses": { "200": { - "description": "Successfully stopped app." + "description": "Succesfully deleted hostname binding." + }, + "204": { + "description": "Hostname binding does not exist." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": { "post": { "tags": [ "WebApps" ], - "summary": "Sync web app repository.", - "description": "Sync web app repository.", - "operationId": "WebApps_SyncRepository", + "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_ListPublishingProfileXmlWithSecretsSlot", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11657,7 +12931,23 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "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" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot.", "required": true, "type": "string" }, @@ -11670,19 +12960,27 @@ ], "responses": { "200": { - "description": "Successfully sync sourcecontrol." + "description": "OK", + "schema": { + "type": "file" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover": { "post": { "tags": [ "WebApps" ], - "summary": "Syncs function trigger metadata to the scale controller", - "description": "Syncs function trigger metadata to the scale controller", - "operationId": "WebApps_SyncFunctionTriggers", + "summary": "Recovers a web app to a previous snapshot.", + "description": "Recovers a web app to a previous snapshot.", + "operationId": "WebApps_RecoverSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11690,7 +12988,23 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "recoveryEntity", + "in": "body", + "description": "Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotRecoveryRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -11702,24 +13016,21 @@ } ], "responses": { - "204": { - "description": "No Content" + "202": { + "description": "Recovery operation started." } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets the quota usage information of an app (or deployment slot, if specified).", - "description": "Gets the quota usage information of an app (or deployment slot, if specified).", - "operationId": "WebApps_ListUsages", - "produces": [ - "application/json", - "text/json" - ], + "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_ResetSlotConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11732,10 +13043,10 @@ "type": "string" }, { - "name": "$filter", - "in": "query", - "description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "x-ms-skip-url-encoding": true, + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot.", + "required": true, "type": "string" }, { @@ -11747,31 +13058,19 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CsmUsageQuotaCollection" - } + "description": "OK." } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": { + "post": { "tags": [ "WebApps" ], - "summary": "Gets the virtual networks the app (or deployment slot) is connected to.", - "description": "Gets the virtual networks the app (or deployment slot) is connected to.", - "operationId": "WebApps_ListVnetConnections", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "summary": "Restarts an app (or deployment slot, if specified).", + "description": "Restarts an app (or deployment slot, if specified).", + "operationId": "WebApps_RestartSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -11784,38 +13083,49 @@ "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will restart the production slot.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/apiVersionParameter" + "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": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetInfo" - } - } + "description": "Successfully restarted app." } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions": { "get": { "tags": [ "WebApps" ], - "summary": "Gets a virtual network the app (or deployment slot) is connected to by name.", - "description": "Gets a virtual network the app (or deployment slot) is connected to by name.", - "operationId": "WebApps_GetVnetConnection", + "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_ListSiteExtensionsSlot", "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -11824,14 +13134,14 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "vnetName", + "name": "slot", "in": "path", - "description": "Name of the virtual network.", + "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" }, @@ -11844,25 +13154,28 @@ ], "responses": { "200": { - "description": "OK", + "description": "SiteExtension information returned.", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/SiteExtensionInfoCollection" } + }, + "404": { + "description": "SiteExtension not found." } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{extensionName}": { + "get": { "tags": [ "WebApps" ], - "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", - "description": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", - "operationId": "WebApps_CreateOrUpdateVnetConnection", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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_GetSiteExtensionSlot", "produces": [ "application/json", "text/json", @@ -11876,64 +13189,27 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "vnetName", - "in": "path", - "description": "Name of an existing Virtual Network.", + "name": "siteExtensionId", + "in": "query", + "description": "Site extension name.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "Properties of the Virtual Network connection. See example.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetInfo" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetInfo" - } - } - } - }, - "delete": { - "tags": [ - "WebApps" - ], - "summary": "Deletes a connection from an app (or deployment slot to a named virtual network.", - "description": "Deletes a connection from an app (or deployment slot to a named virtual network.", - "operationId": "WebApps_DeleteVnetConnection", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", + "name": "slot", "in": "path", - "description": "Name of the app.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { - "name": "vnetName", + "name": "extensionName", "in": "path", - "description": "Name of the virtual network.", "required": true, "type": "string" }, @@ -11946,25 +13222,23 @@ ], "responses": { "200": { - "description": "Succesfully deleted virtual network." + "description": "SiteExtension information returned.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } }, "404": { - "description": "Virtual network does not exist." + "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } }, - "patch": { + "put": { "tags": [ "WebApps" ], - "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", - "description": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", - "operationId": "WebApps_UpdateVnetConnection", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "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_InstallSiteExtensionSlot", "produces": [ "application/json", "text/json", @@ -11978,25 +13252,29 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "vnetName", + "name": "siteExtensionId", + "in": "query", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "name": "slot", "in": "path", - "description": "Name of an existing Virtual Network.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "Properties of the Virtual Network connection. See example.", + "name": "extensionName", + "in": "path", "required": true, - "schema": { - "$ref": "#/definitions/VnetInfo" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -12006,29 +13284,31 @@ } ], "responses": { + "201": { + "description": "Site Extension created.", + "schema": { + "$ref": "#/definitions/SiteExtensionInfo" + } + }, "200": { - "description": "OK", + "description": "Site Extension created.", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/SiteExtensionInfo" } + }, + "429": { + "description": "Site Extension is being installed on another request: Rejecting current request." } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { - "get": { + }, + "x-ms-long-running-operation": true + }, + "delete": { "tags": [ "WebApps" ], - "summary": "Gets an app's Virtual Network gateway.", - "description": "Gets an app's Virtual Network gateway.", - "operationId": "WebApps_GetVnetConnectionGateway", - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], + "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_DeleteSiteExtensionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -12036,21 +13316,27 @@ { "name": "name", "in": "path", - "description": "Name of the app.", + "description": "Site name.", "required": true, "type": "string" }, { - "name": "vnetName", + "name": "siteExtensionId", + "in": "query", + "description": "Site extension name.", + "required": true, + "type": "string" + }, + { + "name": "slot", "in": "path", - "description": "Name of the Virtual Network.", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { - "name": "gatewayName", + "name": "extensionName", "in": "path", - "description": "Name of the gateway. Currently, the only supported string is \"primary\".", "required": true, "type": "string" }, @@ -12062,34 +13348,33 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetGateway" - } + "204": { + "description": "SiteExtension terminated." }, "404": { - "description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently." + "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs": { + "post": { "tags": [ "WebApps" ], - "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", - "description": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", - "operationId": "WebApps_CreateOrUpdateVnetConnectionGateway", + "summary": "Get the difference in configuration settings between two web app slots.", + "description": "Get the difference in configuration settings between two web app slots.", + "operationId": "WebApps_ListSlotDifferencesSlot", "consumes": [ "application/json", "text/json", + "application/xml", + "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -12103,28 +13388,21 @@ "type": "string" }, { - "name": "vnetName", - "in": "path", - "description": "Name of the Virtual Network.", + "name": "slotSwapEntity", + "in": "body", + "description": "JSON object that contains the target slot name. See example.", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } }, { - "name": "gatewayName", + "name": "slot", "in": "path", - "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "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" }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties to update this gateway with.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -12136,28 +13414,29 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/SlotDifferenceCollection" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": { + "post": { "tags": [ "WebApps" ], - "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", - "description": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", - "operationId": "WebApps_UpdateVnetConnectionGateway", + "summary": "Swaps two deployment slots of an app.", + "description": "Swaps two deployment slots of an app.", + "operationId": "WebApps_SwapSlotSlot", "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ "application/json", "text/json", "application/xml", - "text/xml" + "text/xml", + "application/x-www-form-urlencoded" ], "parameters": [ { @@ -12171,11 +13450,2660 @@ "type": "string" }, { - "name": "vnetName", - "in": "path", - "description": "Name of the Virtual Network.", + "name": "slotSwapEntity", + "in": "body", + "description": "JSON object that contains the target slot name. See example.", "required": true, - "type": "string" + "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.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Operation is in progress." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns all Snapshots to the user.", + "description": "Returns all Snapshots to the user.", + "operationId": "WebApps_ListSnapshotsSlot", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Website Name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Website Slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the source control configuration of an app.", + "description": "Gets the source control configuration of an app.", + "operationId": "WebApps_GetSourceControlSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the source control configuration of an app.", + "description": "Updates the source control configuration of an app.", + "operationId": "WebApps_CreateOrUpdateSourceControlSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "JSON representation of a SiteSourceControl object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully created or updated source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes the source control configuration of an app.", + "description": "Deletes the source control configuration of an app.", + "operationId": "WebApps_DeleteSourceControlSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the source control configuration for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted source control for web app." + }, + "202": { + "description": "Source control delete operation in progress." + }, + "404": { + "description": "Source control does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Starts an app (or deployment slot, if specified).", + "description": "Starts an app (or deployment slot, if specified).", + "operationId": "WebApps_StartSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will start the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully started app." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stops an app (or deployment slot, if specified).", + "description": "Stops an app (or deployment slot, if specified).", + "operationId": "WebApps_StopSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will stop the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully stopped app." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Sync web app repository.", + "description": "Sync web app repository.", + "operationId": "WebApps_SyncRepositorySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "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" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully sync sourcecontrol." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Syncs function trigger metadata to the scale controller", + "description": "Syncs function trigger metadata to the scale controller", + "operationId": "WebApps_SyncFunctionTriggersSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List triggered web jobs for an app, or a deployment slot.", + "description": "List triggered web jobs for an app, or a deployment slot.", + "operationId": "WebApps_ListTriggeredWebJobsSlot", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggeredWebJobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a triggered web job by its ID for an app, or a deployment slot.", + "description": "Gets a triggered web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetTriggeredWebJobSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "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" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredWebJob" + } + }, + "404": { + "description": "Triggered web job does not exist." + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a triggered web job by its ID for an app, or a deployment slot.", + "description": "Delete a triggered web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteTriggeredWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "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" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted continuous web job." + }, + "204": { + "description": "Triggered web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List a triggered web job's history for an app, or a deployment slot.", + "description": "List a triggered web job's history for an app, or a deployment slot.", + "operationId": "WebApps_ListTriggeredWebJobHistorySlot", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "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" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredJobHistoryCollection" + } + }, + "404": { + "description": "Triggered web job does not exist." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.", + "description": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.", + "operationId": "WebApps_GetTriggeredWebJobHistorySlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "History ID.", + "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" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredJobHistory" + } + }, + "404": { + "description": "Triggered web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Run a triggered web job for an app, or a deployment slot.", + "description": "Run a triggered web job for an app, or a deployment slot.", + "operationId": "WebApps_RunTriggeredWebJobSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "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" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Triggered web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the quota usage information of an app (or deployment slot, if specified).", + "description": "Gets the quota usage information of an app (or deployment slot, if specified).", + "operationId": "WebApps_ListUsagesSlot", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "x-ms-skip-url-encoding": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmUsageQuotaCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the virtual networks the app (or deployment slot) is connected to.", + "description": "Gets the virtual networks the app (or deployment slot) is connected to.", + "operationId": "WebApps_ListVnetConnectionsSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VnetInfo" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a virtual network the app (or deployment slot) is connected to by name.", + "description": "Gets a virtual network the app (or deployment slot) is connected to by name.", + "operationId": "WebApps_GetVnetConnectionSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network.", + "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 named virtual network for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "description": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "operationId": "WebApps_CreateOrUpdateVnetConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of an existing Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a connection from an app (or deployment slot to a named virtual network.", + "description": "Deletes a connection from an app (or deployment slot to a named virtual network.", + "operationId": "WebApps_DeleteVnetConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network.", + "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 connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist." + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "description": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "operationId": "WebApps_UpdateVnetConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of an existing Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets an app's Virtual Network gateway.", + "description": "Gets an app's Virtual Network gateway.", + "operationId": "WebApps_GetVnetConnectionGatewaySlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "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 gateway for the production slot's Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + "404": { + "description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently." + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "description": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "operationId": "WebApps_CreateOrUpdateVnetConnectionGatewaySlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "description": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "operationId": "WebApps_UpdateVnetConnectionGatewaySlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List webjobs for an app, or a deployment slot.", + "description": "List webjobs for an app, or a deployment slot.", + "operationId": "WebApps_ListWebJobsSlot", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebJobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get webjob information for an app, or a deployment slot.", + "description": "Get webjob information for an app, or a deployment slot.", + "operationId": "WebApps_GetWebJobSlot", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of the web job.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebJob" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Get the difference in configuration settings between two web app slots.", + "description": "Get the difference in configuration settings between two web app slots.", + "operationId": "WebApps_ListSlotDifferencesFromProduction", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "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" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SlotDifferenceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Swaps two deployment slots of an app.", + "description": "Swaps two deployment slots of an app.", + "operationId": "WebApps_SwapSlotWithProduction", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "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" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Operation is in progress." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns all Snapshots to the user.", + "description": "Returns all Snapshots to the user.", + "operationId": "WebApps_ListSnapshots", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Website Name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the source control configuration of an app.", + "description": "Gets the source control configuration of an app.", + "operationId": "WebApps_GetSourceControl", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "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/SiteSourceControl" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates the source control configuration of an app.", + "description": "Updates the source control configuration of an app.", + "operationId": "WebApps_CreateOrUpdateSourceControl", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "JSON representation of a SiteSourceControl object. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully created or updated source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes the source control configuration of an app.", + "description": "Deletes the source control configuration of an app.", + "operationId": "WebApps_DeleteSourceControl", + "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": "Succesfully deleted source control for web app." + }, + "202": { + "description": "Source control delete operation in progress." + }, + "404": { + "description": "Source control does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Starts an app (or deployment slot, if specified).", + "description": "Starts an app (or deployment slot, if specified).", + "operationId": "WebApps_Start", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully started app." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stops an app (or deployment slot, if specified).", + "description": "Stops an app (or deployment slot, if specified).", + "operationId": "WebApps_Stop", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully stopped app." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Sync web app repository.", + "description": "Sync web app repository.", + "operationId": "WebApps_SyncRepository", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully sync sourcecontrol." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Syncs function trigger metadata to the scale controller", + "description": "Syncs function trigger metadata to the scale controller", + "operationId": "WebApps_SyncFunctionTriggers", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List triggered web jobs for an app, or a deployment slot.", + "description": "List triggered web jobs for an app, or a deployment slot.", + "operationId": "WebApps_ListTriggeredWebJobs", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggeredWebJobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a triggered web job by its ID for an app, or a deployment slot.", + "description": "Gets a triggered web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_GetTriggeredWebJob", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredWebJob" + } + }, + "404": { + "description": "Triggered web job does not exist." + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a triggered web job by its ID for an app, or a deployment slot.", + "description": "Delete a triggered web job by its ID for an app, or a deployment slot.", + "operationId": "WebApps_DeleteTriggeredWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted continuous web job." + }, + "204": { + "description": "Triggered web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List a triggered web job's history for an app, or a deployment slot.", + "description": "List a triggered web job's history for an app, or a deployment slot.", + "operationId": "WebApps_ListTriggeredWebJobHistory", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredJobHistoryCollection" + } + }, + "404": { + "description": "Triggered web job does not exist." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.", + "description": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.", + "operationId": "WebApps_GetTriggeredWebJobHistory", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "History ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job.", + "schema": { + "$ref": "#/definitions/TriggeredJobHistory" + } + }, + "404": { + "description": "Triggered web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Run a triggered web job for an app, or a deployment slot.", + "description": "Run a triggered web job for an app, or a deployment slot.", + "operationId": "WebApps_RunTriggeredWebJob", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobId", + "in": "query", + "description": "Web job ID.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Found continuous web job." + }, + "404": { + "description": "Triggered web job does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the quota usage information of an app (or deployment slot, if specified).", + "description": "Gets the quota usage information of an app (or deployment slot, if specified).", + "operationId": "WebApps_ListUsages", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "x-ms-skip-url-encoding": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmUsageQuotaCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets the virtual networks the app (or deployment slot) is connected to.", + "description": "Gets the virtual networks the app (or deployment slot) is connected to.", + "operationId": "WebApps_ListVnetConnections", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "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": { + "type": "array", + "items": { + "$ref": "#/definitions/VnetInfo" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a virtual network the app (or deployment slot) is connected to by name.", + "description": "Gets a virtual network the app (or deployment slot) is connected to by name.", + "operationId": "WebApps_GetVnetConnection", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "description": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "operationId": "WebApps_CreateOrUpdateVnetConnection", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of an existing Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a connection from an app (or deployment slot to a named virtual network.", + "description": "Deletes a connection from an app (or deployment slot to a named virtual network.", + "operationId": "WebApps_DeleteVnetConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist." + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "description": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).", + "operationId": "WebApps_UpdateVnetConnection", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of an existing Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets an app's Virtual Network gateway.", + "description": "Gets an app's Virtual Network gateway.", + "operationId": "WebApps_GetVnetConnectionGateway", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + "404": { + "description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently." + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "description": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "operationId": "WebApps_CreateOrUpdateVnetConnectionGateway", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Currently, the only supported string is \"primary\".", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "description": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).", + "operationId": "WebApps_UpdateVnetConnectionGateway", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the Virtual Network.", + "required": true, + "type": "string" }, { "name": "gatewayName", @@ -12209,6 +16137,98 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "List webjobs for an app, or a deployment slot.", + "description": "List webjobs for an app, or a deployment slot.", + "operationId": "WebApps_ListWebJobs", + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebJobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Get webjob information for an app, or a deployment slot.", + "description": "Get webjob information for an app, or a deployment slot.", + "operationId": "WebApps_GetWebJob", + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site name.", + "required": true, + "type": "string" + }, + { + "name": "webJobName", + "in": "path", + "description": "Name of the web job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebJob" + } + } + } + } } }, "definitions": { @@ -12778,13 +16798,114 @@ } ], "properties": { - "properties": { - "description": "Connection strings.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConnStringValueTypePair" - }, - "x-ms-client-flatten": true + "properties": { + "description": "Connection strings.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConnStringValueTypePair" + }, + "x-ms-client-flatten": true + } + } + }, + "ContinuousWebJob": { + "description": "Continuous Web Job Information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "ContinuousWebJob resource specific properties", + "properties": { + "status": { + "description": "Job status.", + "enum": [ + "Initializing", + "Starting", + "Running", + "PendingRestart", + "Stopped" + ], + "type": "string", + "x-ms-enum": { + "name": "ContinuousWebJobStatus", + "modelAsString": false + } + }, + "detailedStatus": { + "description": "Detailed status.", + "type": "string" + }, + "logUrl": { + "description": "Log URL.", + "type": "string" + }, + "name": { + "description": "Job name. Used as job identifier in ARM resource URI.", + "type": "string", + "readOnly": true + }, + "runCommand": { + "description": "Run command.", + "type": "string" + }, + "url": { + "description": "Job URL.", + "type": "string" + }, + "extraInfoUrl": { + "description": "Extra Info URL.", + "type": "string" + }, + "jobType": { + "description": "Job type.", + "enum": [ + "Continuous", + "Triggered" + ], + "type": "string", + "x-ms-enum": { + "name": "WebJobType", + "modelAsString": false + } + }, + "error": { + "description": "Error information.", + "type": "string" + }, + "usingSdk": { + "description": "Using SDK?", + "type": "boolean" + }, + "settings": { + "description": "Job settings.", + "type": "object" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ContinuousWebJobCollection": { + "description": "Collection of Kudu continuous web job information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContinuousWebJob" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string" } } }, @@ -13203,6 +17324,113 @@ } } }, + "FunctionEnvelope": { + "description": "Web Job Information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "FunctionEnvelope resource specific properties", + "properties": { + "name": { + "description": "Function name.", + "type": "string", + "readOnly": true + }, + "functionAppId": { + "description": "Function App ID.", + "type": "string", + "readOnly": true + }, + "scriptRootPathHref": { + "description": "Script root path URI.", + "type": "string" + }, + "scriptHref": { + "description": "Script URI.", + "type": "string" + }, + "configHref": { + "description": "Config URI.", + "type": "string" + }, + "secretsFileHref": { + "description": "Secrets file URI.", + "type": "string" + }, + "href": { + "description": "Function URI.", + "type": "string" + }, + "config": { + "description": "Config information.", + "type": "object" + }, + "files": { + "description": "File list.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "testData": { + "description": "Test data used when testing via the Azure Portal.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "FunctionEnvelopeCollection": { + "description": "Collection of Kudu function information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/FunctionEnvelope" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string" + } + } + }, + "FunctionSecrets": { + "description": "Function secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "FunctionSecrets resource specific properties", + "properties": { + "key": { + "description": "Secret key.", + "type": "string" + }, + "triggerUrl": { + "description": "Trigger URL.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, "HandlerMapping": { "description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \n For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.", "type": "object", @@ -13307,42 +17535,228 @@ "Managed" ], "type": "string", - "x-ms-enum": { - "name": "HostNameType", - "modelAsString": false - }, + "x-ms-enum": { + "name": "HostNameType", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "sslState": { + "description": "SSL type", + "enum": [ + "Disabled", + "SniEnabled", + "IpBasedEnabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SslState", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "thumbprint": { + "description": "SSL certificate thumbprint", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "virtualIP": { + "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "HostNameBindingCollection": { + "description": "Collection of hostname bindings.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/HostNameBinding" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string" + } + } + }, + "HostNameSslState": { + "description": "SSL-enabled hostname.", + "type": "object", + "properties": { + "name": { + "description": "Hostname.", + "type": "string" + }, + "sslState": { + "description": "SSL type.", + "enum": [ + "Disabled", + "SniEnabled", + "IpBasedEnabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SslState", + "modelAsString": false + } + }, + "virtualIP": { + "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.", + "type": "string" + }, + "thumbprint": { + "description": "SSL certificate thumbprint.", + "type": "string" + }, + "toUpdate": { + "description": "Set to true to update existing hostname.", + "type": "boolean" + }, + "hostType": { + "description": "Indicates whether the hostname is a standard or repository hostname.", + "enum": [ + "Standard", + "Repository" + ], + "type": "string", + "x-ms-enum": { + "name": "HostType", + "modelAsString": false + } + } + } + }, + "HostingEnvironmentProfile": { + "description": "Specification for an App Service Environment to use for this resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of the App Service Environment.", + "type": "string" + }, + "name": { + "description": "Name of the App Service Environment.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type of the App Service Environment.", + "type": "string", + "readOnly": true + } + } + }, + "HttpLogsConfig": { + "description": "Http logs configuration.", + "type": "object", + "properties": { + "fileSystem": { + "$ref": "#/definitions/FileSystemHttpLogsConfig", + "description": "Http logs to file system configuration." + }, + "azureBlobStorage": { + "$ref": "#/definitions/AzureBlobStorageHttpLogsConfig", + "description": "Http logs to azure blob storage configuration." + } + } + }, + "HybridConnection": { + "description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HybridConnection resource specific properties", + "properties": { + "serviceBusNamespace": { + "description": "The name of the Service Bus namespace.", + "type": "string", "x-ms-mutability": [ "create", "read" ] }, - "sslState": { - "description": "SSL type", - "enum": [ - "Disabled", - "SniEnabled", - "IpBasedEnabled" - ], + "relayName": { + "description": "The name of the Service Bus relay.", "type": "string", - "x-ms-enum": { - "name": "SslState", - "modelAsString": false - }, "x-ms-mutability": [ "create", "read" ] }, - "thumbprint": { - "description": "SSL certificate thumbprint", + "relayArmUri": { + "description": "The ARM URI to the Service Bus relay.", + "type": "string" + }, + "hostname": { + "description": "The hostname of the endpoint.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port of the endpoint.", + "type": "integer" + }, + "sendKeyName": { + "description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.", + "type": "string" + }, + "sendKeyValue": { + "description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\n normally, use the POST /listKeys API instead.", + "type": "string" + }, + "serviceBusSuffix": { + "description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "HybridConnectionKey": { + "description": "Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "HybridConnectionKey resource specific properties", + "properties": { + "sendKeyName": { + "description": "The name of the send key.", "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] + "readOnly": true }, - "virtualIP": { - "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.", + "sendKeyValue": { + "description": "The value of the send key.", "type": "string", "readOnly": true } @@ -13351,8 +17765,29 @@ } } }, - "HostNameBindingCollection": { - "description": "Collection of hostname bindings.", + "Identifier": { + "description": "Identifier.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "Identifier resource specific properties", + "properties": { + "id": { + "description": "String representation of the identity.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "IdentifierCollection": { + "description": "Collection of identifiers.", "required": [ "value" ], @@ -13362,7 +17797,7 @@ "description": "Collection of resources.", "type": "array", "items": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Identifier" } }, "nextLink": { @@ -13371,89 +17806,156 @@ } } }, - "HostNameSslState": { - "description": "SSL-enabled hostname.", + "IpSecurityRestriction": { + "description": "IP security restriction on an app.", + "required": [ + "ipAddress" + ], "type": "object", "properties": { - "name": { - "description": "Hostname.", + "ipAddress": { + "description": "IP address the security restriction is valid for.", "type": "string" }, - "sslState": { - "description": "SSL type.", - "enum": [ - "Disabled", - "SniEnabled", - "IpBasedEnabled" - ], - "type": "string", - "x-ms-enum": { - "name": "SslState", - "modelAsString": false - } + "subnetMask": { + "description": "Subnet mask for the range of IP addresses the restriction is valid for.", + "type": "string" + } + } + }, + "LocalizableString": { + "description": "Localizable string object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "Non-localized name.", + "type": "string" }, - "virtualIP": { - "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.", + "localizedValue": { + "description": "Localized name.", + "type": "string" + } + } + }, + "MSDeploy": { + "description": "MSDeploy ARM PUT information", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MSDeployCore", + "properties": { + "addOnPackages": { + "description": "List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.", + "type": "array", + "items": { + "$ref": "#/definitions/MSDeployCore" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "MSDeployCore": { + "description": "MSDeploy ARM PUT core information", + "type": "object", + "properties": { + "packageUri": { + "description": "Package URI", "type": "string" }, - "thumbprint": { - "description": "SSL certificate thumbprint.", + "connectionString": { + "description": "SQL Connection String", "type": "string" }, - "toUpdate": { - "description": "Set to true to update existing hostname.", - "type": "boolean" + "dbType": { + "description": "Database Type", + "type": "string" }, - "hostType": { - "description": "Indicates whether the hostname is a standard or repository hostname.", - "enum": [ - "Standard", - "Repository" - ], - "type": "string", - "x-ms-enum": { - "name": "HostType", - "modelAsString": false + "setParametersXmlFileUri": { + "description": "URI of MSDeploy Parameters file. Must not be set if SetParameters is used.", + "type": "string" + }, + "setParameters": { + "description": "MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.", + "type": "object", + "additionalProperties": { + "type": "string" } + }, + "skipAppData": { + "description": "Controls whether the MSDeploy operation skips the App_Data directory.\n If set to true, the existing App_Data directory on the destination\n will not be deleted, and any App_Data directory in the source will be ignored.\n Setting is false by default.", + "type": "boolean" + }, + "appOffline": { + "description": "Sets the AppOffline rule while the MSDeploy operation executes.\n Setting is false by default.", + "type": "boolean" } } }, - "HostingEnvironmentProfile": { - "description": "Specification for an App Service Environment to use for this resource.", + "MSDeployLog": { + "description": "MSDeploy log", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], "properties": { - "id": { - "description": "Resource ID of the App Service Environment.", - "type": "string" - }, - "name": { - "description": "Name of the App Service Environment.", + "properties": { + "description": "MSDeployLog resource specific properties", + "properties": { + "entries": { + "description": "List of log entry messages", + "type": "array", + "items": { + "$ref": "#/definitions/MSDeployLogEntry" + }, + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "MSDeployLogEntry": { + "description": "MSDeploy log entry", + "type": "object", + "properties": { + "time": { + "format": "date-time", + "description": "Timestamp of log entry", "type": "string", "readOnly": true }, - "type": { - "description": "Resource type of the App Service Environment.", + "type": { + "description": "Log entry type", + "enum": [ + "Message", + "Warning", + "Error" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MSDeployLogEntryType", + "modelAsString": false + } + }, + "message": { + "description": "Log entry message", "type": "string", "readOnly": true } } }, - "HttpLogsConfig": { - "description": "Http logs configuration.", - "type": "object", - "properties": { - "fileSystem": { - "$ref": "#/definitions/FileSystemHttpLogsConfig", - "description": "Http logs to file system configuration." - }, - "azureBlobStorage": { - "$ref": "#/definitions/AzureBlobStorageHttpLogsConfig", - "description": "Http logs to azure blob storage configuration." - } - } - }, - "HybridConnection": { - "description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.", + "MSDeployStatus": { + "description": "MSDeploy ARM response", "type": "object", "allOf": [ { @@ -13462,56 +17964,90 @@ ], "properties": { "properties": { - "description": "HybridConnection resource specific properties", + "description": "MSDeployStatus resource specific properties", "properties": { - "serviceBusNamespace": { - "description": "The name of the Service Bus namespace.", + "deployer": { + "description": "Username of deployer", "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] + "readOnly": true }, - "relayName": { - "description": "The name of the Service Bus relay.", + "provisioningState": { + "description": "Provisioning state", + "enum": [ + "accepted", + "running", + "succeeded", + "failed", + "canceled" + ], "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "relayArmUri": { - "description": "The ARM URI to the Service Bus relay.", - "type": "string" - }, - "hostname": { - "description": "The hostname of the endpoint.", - "type": "string" + "readOnly": true, + "x-ms-enum": { + "name": "MSDeployProvisioningState", + "modelAsString": false + } }, - "port": { - "format": "int32", - "description": "The port of the endpoint.", - "type": "integer" + "startTime": { + "format": "date-time", + "description": "Start time of deploy operation", + "type": "string", + "readOnly": true }, - "sendKeyName": { - "description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.", - "type": "string" + "endTime": { + "format": "date-time", + "description": "End time of deploy operation", + "type": "string", + "readOnly": true }, - "sendKeyValue": { - "description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\n normally, use the POST /listKeys API instead.", + "complete": { + "description": "Whether the deployment operation has completed", + "type": "boolean", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "MigrateMySqlRequest": { + "description": "MySQL migration request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "MigrateMySqlRequest resource specific properties", + "required": [ + "connectionString", + "migrationType" + ], + "properties": { + "connectionString": { + "description": "Connection string to the remote MySQL database.", "type": "string" }, - "serviceBusSuffix": { - "description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net", - "type": "string" + "migrationType": { + "description": "The type of migration operation to be done", + "enum": [ + "LocalToRemote", + "RemoteToLocal" + ], + "type": "string", + "x-ms-enum": { + "name": "MySqlMigrationType", + "modelAsString": false + } } }, "x-ms-client-flatten": true } } }, - "HybridConnectionKey": { - "description": "Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.", + "MigrateMySqlStatus": { + "description": "MySQL migration status.", "type": "object", "allOf": [ { @@ -13520,25 +18056,55 @@ ], "properties": { "properties": { - "description": "HybridConnectionKey resource specific properties", + "description": "MigrateMySqlStatus resource specific properties", "properties": { - "sendKeyName": { - "description": "The name of the send key.", + "migrationOperationStatus": { + "description": "Status of the migration task.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "TimedOut", + "Created" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + } }, - "sendKeyValue": { - "description": "The value of the send key.", + "operationId": { + "description": "Operation ID for the migration task.", "type": "string", "readOnly": true + }, + "localMySqlEnabled": { + "description": "True if the web app has in app MySql enabled", + "type": "boolean", + "readOnly": true } }, "x-ms-client-flatten": true } } }, - "Identifier": { - "description": "Identifier.", + "NameValuePair": { + "description": "Name value pair.", + "type": "object", + "properties": { + "name": { + "description": "Pair name.", + "type": "string" + }, + "value": { + "description": "Pair value.", + "type": "string" + } + } + }, + "NetworkFeatures": { + "description": "Full view of network features for an app (presently VNET integration and Hybrid Connections).", "type": "object", "allOf": [ { @@ -13547,19 +18113,96 @@ ], "properties": { "properties": { - "description": "Identifier resource specific properties", + "description": "NetworkFeatures resource specific properties", "properties": { - "id": { - "description": "String representation of the identity.", - "type": "string" + "virtualNetworkName": { + "description": "The Virtual Network name.", + "type": "string", + "readOnly": true + }, + "virtualNetworkConnection": { + "$ref": "#/definitions/VnetInfo", + "description": "The Virtual Network summary view.", + "readOnly": true + }, + "hybridConnections": { + "description": "The Hybrid Connections summary view.", + "type": "array", + "items": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + }, + "readOnly": true + }, + "hybridConnectionsV2": { + "description": "The Hybrid Connection V2 (Service Bus) view.", + "type": "array", + "items": { + "$ref": "#/definitions/HybridConnection" + }, + "readOnly": true } }, "x-ms-client-flatten": true } } }, - "IdentifierCollection": { - "description": "Collection of identifiers.", + "Operation": { + "description": "Operation.", + "type": "object", + "properties": { + "id": { + "description": "Operation ID.", + "type": "string" + }, + "name": { + "description": "Operation name.", + "type": "string" + }, + "status": { + "description": "The current status of the operation.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "TimedOut", + "Created" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + } + }, + "errors": { + "description": "Any errors associate with the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorEntity" + } + }, + "createdTime": { + "format": "date-time", + "description": "Time when operation has started.", + "type": "string" + }, + "modifiedTime": { + "format": "date-time", + "description": "Time when operation has been updated.", + "type": "string" + }, + "expirationTime": { + "format": "date-time", + "description": "Time when operation will expire.", + "type": "string" + }, + "geoMasterOperationId": { + "description": "Applicable only for stamp operation ids.", + "type": "string" + } + } + }, + "PerfMonCounterCollection": { + "description": "Collection of performance monitor counters.", "required": [ "value" ], @@ -13569,7 +18212,7 @@ "description": "Collection of resources.", "type": "array", "items": { - "$ref": "#/definitions/Identifier" + "$ref": "#/definitions/PerfMonResponse" } }, "nextLink": { @@ -13578,248 +18221,135 @@ } } }, - "IpSecurityRestriction": { - "description": "IP security restriction on an app.", - "required": [ - "ipAddress" - ], + "PerfMonResponse": { + "description": "Performance monitor API response.", "type": "object", "properties": { - "ipAddress": { - "description": "IP address the security restriction is valid for.", + "code": { + "description": "The response code.", "type": "string" }, - "subnetMask": { - "description": "Subnet mask for the range of IP addresses the restriction is valid for.", + "message": { + "description": "The message.", "type": "string" + }, + "data": { + "$ref": "#/definitions/PerfMonSet", + "description": "The performance monitor counters." } } }, - "LocalizableString": { - "description": "Localizable string object containing the name and a localized value.", + "PerfMonSample": { + "description": "Performance monitor sample in a set.", "type": "object", "properties": { - "value": { - "description": "Non-localized name.", + "time": { + "format": "date-time", + "description": "Point in time for which counter was measured.", "type": "string" }, - "localizedValue": { - "description": "Localized name.", + "instanceName": { + "description": "Name of the server on which the measurement is made.", "type": "string" + }, + "value": { + "format": "double", + "description": "Value of counter at a certain time.", + "type": "number" + }, + "coreCount": { + "format": "int32", + "description": "Core Count of worker. Not a data member", + "type": "integer" } } }, - "MSDeploy": { - "description": "MSDeploy ARM PUT information", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyOnlyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/MSDeployCore", - "properties": { - "addOnPackages": { - "description": "List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.", - "type": "array", - "items": { - "$ref": "#/definitions/MSDeployCore" - } - } - }, - "x-ms-client-flatten": true - } - } - }, - "MSDeployCore": { - "description": "MSDeploy ARM PUT core information", + "PerfMonSet": { + "description": "Metric information.", "type": "object", "properties": { - "packageUri": { - "description": "Package URI", + "name": { + "description": "Unique key name of the counter.", "type": "string" }, - "connectionString": { - "description": "SQL Connection String", + "startTime": { + "format": "date-time", + "description": "Start time of the period.", "type": "string" }, - "dbType": { - "description": "Database Type", + "endTime": { + "format": "date-time", + "description": "End time of the period.", "type": "string" }, - "setParametersXmlFileUri": { - "description": "URI of MSDeploy Parameters file. Must not be set if SetParameters is used.", + "timeGrain": { + "description": "Presented time grain.", "type": "string" }, - "setParameters": { - "description": "MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "skipAppData": { - "description": "Controls whether the MSDeploy operation skips the AppData directory. If set to true, the existing AppData directory on the destination will not be deleted and overwritten.", - "type": "boolean" - }, - "appOffline": { - "description": "Sets the AppOffline rule while the MSDeploy operation executes.", - "type": "boolean" - } - } - }, - "MSDeployLog": { - "description": "MSDeploy log", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyOnlyResource" - } - ], - "properties": { - "properties": { - "description": "MSDeployLog resource specific properties", - "properties": { - "entries": { - "description": "List of log entry messages", - "type": "array", - "items": { - "$ref": "#/definitions/MSDeployLogEntry" - }, - "readOnly": true - } - }, - "x-ms-client-flatten": true - } - } - }, - "MSDeployLogEntry": { - "description": "MSDeploy log entry", - "type": "object", - "properties": { - "time": { - "format": "date-time", - "description": "Timestamp of log entry", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Log entry type", - "enum": [ - "Message", - "Warning", - "Error" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "MSDeployLogEntryType", - "modelAsString": false + "values": { + "description": "Collection of workers that are active during this time.", + "type": "array", + "items": { + "$ref": "#/definitions/PerfMonSample" } - }, - "message": { - "description": "Log entry message", - "type": "string", - "readOnly": true } } }, - "MSDeployStatus": { - "description": "MSDeploy ARM response", + "PremierAddOn": { + "description": "Premier add-on.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyOnlyResource" + "$ref": "#/definitions/Resource" } ], "properties": { "properties": { - "description": "MSDeployStatus resource specific properties", + "description": "PremierAddOn resource specific properties", "properties": { - "deployer": { - "description": "Username of deployer", - "type": "string", - "readOnly": true + "sku": { + "description": "SKU.", + "type": "string" }, - "provisioningState": { - "description": "Provisioning state", - "enum": [ - "accepted", - "running", - "succeeded", - "failed", - "canceled" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "MSDeployProvisioningState", - "modelAsString": false - } + "product": { + "description": "Product.", + "type": "string" }, - "startTime": { - "format": "date-time", - "description": "Start time of deploy operation", - "type": "string", - "readOnly": true + "vendor": { + "description": "Vendor.", + "type": "string" }, - "endTime": { - "format": "date-time", - "description": "End time of deploy operation", + "name": { + "description": "Name.", "type": "string", - "readOnly": true + "x-ms-client-name": "PremierAddOnName" }, - "complete": { - "description": "Whether the deployment operation has completed", - "type": "boolean", - "readOnly": true - } - }, - "x-ms-client-flatten": true - } - } - }, - "MigrateMySqlRequest": { - "description": "MySQL migration request.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyOnlyResource" - } - ], - "properties": { - "properties": { - "description": "MigrateMySqlRequest resource specific properties", - "required": [ - "connectionString", - "migrationType" - ], - "properties": { - "connectionString": { - "description": "Connection string to the remote MySQL database.", + "location": { + "description": "Location.", + "type": "string" + }, + "tags": { + "description": "Tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "marketplacePublisher": { + "description": "Marketplace publisher.", "type": "string" }, - "migrationType": { - "description": "The type of migration operation to be done", - "enum": [ - "LocalToRemote", - "RemoteToLocal" - ], - "type": "string", - "x-ms-enum": { - "name": "MySqlMigrationType", - "modelAsString": false - } + "marketplaceOffer": { + "description": "Marketplace offer.", + "type": "string" } }, "x-ms-client-flatten": true } } }, - "MigrateMySqlStatus": { - "description": "MySQL migration status.", + "ProcessInfo": { + "description": "Process Information.", "type": "object", "allOf": [ { @@ -13828,55 +18358,214 @@ ], "properties": { "properties": { - "description": "MigrateMySqlStatus resource specific properties", + "description": "ProcessInfo resource specific properties", "properties": { - "migrationOperationStatus": { - "description": "Status of the migration task.", - "enum": [ - "InProgress", - "Failed", - "Succeeded", - "TimedOut", - "Created" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "OperationStatus", - "modelAsString": false + "id": { + "format": "int32", + "description": "ARM Identifier for deployment.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "name": { + "description": "Deployment name.", + "type": "string" + }, + "href": { + "description": "HRef URI.", + "type": "string" + }, + "miniDump": { + "description": "Minidump URI.", + "type": "string" + }, + "isProfileRunning": { + "description": "Is profile running?", + "type": "boolean" + }, + "isIisProfileRunning": { + "description": "Is the IIS Profile running?", + "type": "boolean" + }, + "iisProfileTimeoutInSeconds": { + "format": "double", + "description": "IIS Profile timeout (seconds).", + "type": "number" + }, + "parent": { + "description": "Parent process.", + "type": "string" + }, + "children": { + "description": "Child process list.", + "type": "array", + "items": { + "type": "string" } }, - "operationId": { - "description": "Operation ID for the migration task.", - "type": "string", - "readOnly": true + "threads": { + "description": "Thread list.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessThreadInfo" + } }, - "localMySqlEnabled": { - "description": "True if the web app has in app MySql enabled", - "type": "boolean", - "readOnly": true + "openFileHandles": { + "description": "List of open files.", + "type": "array", + "items": { + "type": "string" + } + }, + "modules": { + "description": "List of modules.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessModuleInfo" + } + }, + "fileName": { + "description": "File name of this process.", + "type": "string" + }, + "commandLine": { + "description": "Command line.", + "type": "string" + }, + "userName": { + "description": "User name.", + "type": "string" + }, + "handleCount": { + "format": "int32", + "description": "Handle count.", + "type": "integer" + }, + "moduleCount": { + "format": "int32", + "description": "Module count.", + "type": "integer" + }, + "threadCount": { + "format": "int32", + "description": "Thread count.", + "type": "integer" + }, + "startTime": { + "format": "date-time", + "description": "Start time.", + "type": "string" + }, + "totalProcessorTime": { + "description": "Total CPU time.", + "type": "string" + }, + "userProcessorTime": { + "description": "User CPU time.", + "type": "string" + }, + "privilegedProcessorTime": { + "description": "Privileged CPU time.", + "type": "string" + }, + "workingSet64": { + "format": "int64", + "description": "Working set.", + "type": "integer" + }, + "peakWorkingSet64": { + "format": "int64", + "description": "Peak working set.", + "type": "integer" + }, + "privateMemorySize64": { + "format": "int64", + "description": "Private memory size.", + "type": "integer" + }, + "virtualMemorySize64": { + "format": "int64", + "description": "Virtual memory size.", + "type": "integer" + }, + "peakVirtualMemorySize64": { + "format": "int64", + "description": "Peak virtual memory usage.", + "type": "integer" + }, + "pagedSystemMemorySize64": { + "format": "int64", + "description": "Paged system memory.", + "type": "integer" + }, + "nonpagedSystemMemorySize64": { + "format": "int64", + "description": "Non-paged system memory.", + "type": "integer" + }, + "pagedMemorySize64": { + "format": "int64", + "description": "Paged memory.", + "type": "integer" + }, + "peakPagedMemorySize64": { + "format": "int64", + "description": "Peak paged memory.", + "type": "integer" + }, + "timeStamp": { + "format": "date-time", + "description": "Time stamp.", + "type": "string" + }, + "environmentVariables": { + "description": "List of environment variables.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "isScmSite": { + "description": "Is this the SCM site?", + "type": "boolean" + }, + "isWebJob": { + "description": "Is this a Web Job?", + "type": "boolean" + }, + "description": { + "description": "Description of process.", + "type": "string" } }, "x-ms-client-flatten": true } } }, - "NameValuePair": { - "description": "Name value pair.", + "ProcessInfoCollection": { + "description": "Collection of Kudu process information elements.", + "required": [ + "value" + ], "type": "object", "properties": { - "name": { - "description": "Pair name.", - "type": "string" - }, "value": { - "description": "Pair value.", + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessInfo" + } + }, + "nextLink": { + "description": "Link to next page of resources.", "type": "string" } } }, - "NetworkFeatures": { - "description": "Full view of network features for an app (presently VNET integration and Hybrid Connections).", + "ProcessModuleInfo": { + "description": "Process Module Information.", "type": "object", "allOf": [ { @@ -13885,96 +18574,60 @@ ], "properties": { "properties": { - "description": "NetworkFeatures resource specific properties", + "description": "ProcessModuleInfo resource specific properties", "properties": { - "virtualNetworkName": { - "description": "The Virtual Network name.", - "type": "string", - "readOnly": true + "baseAddress": { + "description": "Base address. Used as module identifier in ARM resource URI.", + "type": "string" }, - "virtualNetworkConnection": { - "$ref": "#/definitions/VnetInfo", - "description": "The Virtual Network summary view.", - "readOnly": true + "fileName": { + "description": "File name.", + "type": "string" }, - "hybridConnections": { - "description": "The Hybrid Connections summary view.", - "type": "array", - "items": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - }, - "readOnly": true + "href": { + "description": "HRef URI.", + "type": "string" }, - "hybridConnectionsV2": { - "description": "The Hybrid Connection V2 (Service Bus) view.", - "type": "array", - "items": { - "$ref": "#/definitions/HybridConnection" - }, - "readOnly": true - } - }, - "x-ms-client-flatten": true - } - } - }, - "Operation": { - "description": "Operation.", - "type": "object", - "properties": { - "id": { - "description": "Operation ID.", - "type": "string" - }, - "name": { - "description": "Operation name.", - "type": "string" - }, - "status": { - "description": "The current status of the operation.", - "enum": [ - "InProgress", - "Failed", - "Succeeded", - "TimedOut", - "Created" - ], - "type": "string", - "x-ms-enum": { - "name": "OperationStatus", - "modelAsString": false - } - }, - "errors": { - "description": "Any errors associate with the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorEntity" - } - }, - "createdTime": { - "format": "date-time", - "description": "Time when operation has started.", - "type": "string" - }, - "modifiedTime": { - "format": "date-time", - "description": "Time when operation has been updated.", - "type": "string" - }, - "expirationTime": { - "format": "date-time", - "description": "Time when operation will expire.", - "type": "string" - }, - "geoMasterOperationId": { - "description": "Applicable only for stamp operation ids.", - "type": "string" + "filePath": { + "description": "File path.", + "type": "string" + }, + "moduleMemorySize": { + "format": "int32", + "description": "Module memory size.", + "type": "integer" + }, + "fileVersion": { + "description": "File version.", + "type": "string" + }, + "fileDescription": { + "description": "File description.", + "type": "string" + }, + "product": { + "description": "Product name.", + "type": "string" + }, + "productVersion": { + "description": "Product version.", + "type": "string" + }, + "isDebug": { + "description": "Is debug?", + "type": "boolean" + }, + "language": { + "description": "Module language (locale).", + "type": "string" + } + }, + "x-ms-client-flatten": true } } }, - "PerfMonCounterCollection": { - "description": "Collection of performance monitor counters.", + "ProcessModuleInfoCollection": { + "description": "Collection of Kudu thread information elements.", "required": [ "value" ], @@ -13984,7 +18637,7 @@ "description": "Collection of resources.", "type": "array", "items": { - "$ref": "#/definitions/PerfMonResponse" + "$ref": "#/definitions/ProcessModuleInfo" } }, "nextLink": { @@ -13993,126 +18646,72 @@ } } }, - "PerfMonResponse": { - "description": "Performance monitor API response.", - "type": "object", - "properties": { - "code": { - "description": "The response code.", - "type": "string" - }, - "message": { - "description": "The message.", - "type": "string" - }, - "data": { - "$ref": "#/definitions/PerfMonSet", - "description": "The performance monitor counters." - } - } - }, - "PerfMonSample": { - "description": "Performance monitor sample in a set.", - "type": "object", - "properties": { - "time": { - "format": "date-time", - "description": "Point in time for which counter was measured.", - "type": "string" - }, - "instanceName": { - "description": "Name of the server on which the measurement is made.", - "type": "string" - }, - "value": { - "format": "double", - "description": "Value of counter at a certain time.", - "type": "number" - }, - "coreCount": { - "format": "int32", - "description": "Core Count of worker. Not a data member", - "type": "integer" - } - } - }, - "PerfMonSet": { - "description": "Metric information.", - "type": "object", - "properties": { - "name": { - "description": "Unique key name of the counter.", - "type": "string" - }, - "startTime": { - "format": "date-time", - "description": "Start time of the period.", - "type": "string" - }, - "endTime": { - "format": "date-time", - "description": "End time of the period.", - "type": "string" - }, - "timeGrain": { - "description": "Presented time grain.", - "type": "string" - }, - "values": { - "description": "Collection of workers that are active during this time.", - "type": "array", - "items": { - "$ref": "#/definitions/PerfMonSample" - } - } - } - }, - "PremierAddOn": { - "description": "Premier add-on.", + "ProcessThreadInfo": { + "description": "Process Thread Information.", "type": "object", "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { - "description": "PremierAddOn resource specific properties", + "description": "ProcessThreadInfo resource specific properties", "properties": { - "sku": { - "description": "SKU.", + "id": { + "format": "int32", + "description": "ARM Identifier for deployment.", + "type": "integer" + }, + "href": { + "description": "HRef URI.", "type": "string" }, - "product": { - "description": "Product.", + "process": { + "description": "Process URI.", "type": "string" }, - "vendor": { - "description": "Vendor.", + "startAddress": { + "description": "Start address.", "type": "string" }, - "name": { - "description": "Name.", - "type": "string", - "x-ms-client-name": "PremierAddOnName" + "currentPriority": { + "format": "int32", + "description": "Current thread priority.", + "type": "integer" }, - "location": { - "description": "Location.", + "priorityLevel": { + "description": "Thread priority level.", "type": "string" }, - "tags": { - "description": "Tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "basePriority": { + "format": "int32", + "description": "Base priority.", + "type": "integer" }, - "marketplacePublisher": { - "description": "Marketplace publisher.", + "startTime": { + "format": "date-time", + "description": "Start time.", "type": "string" }, - "marketplaceOffer": { - "description": "Marketplace offer.", + "totalProcessorTime": { + "description": "Total processor time.", + "type": "string" + }, + "userProcessorTime": { + "description": "User processor time.", + "type": "string" + }, + "priviledgedProcessorTime": { + "description": "Priviledged processor time.", + "type": "string" + }, + "state": { + "description": "Thread state.", + "type": "string" + }, + "waitReason": { + "description": "Wait reason.", "type": "string" } }, @@ -14120,6 +18719,26 @@ } } }, + "ProcessThreadInfoCollection": { + "description": "Collection of Kudu thread information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessThreadInfo" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string" + } + } + }, "ProxyOnlyResource": { "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.", "properties": { @@ -14676,6 +19295,10 @@ "default": false, "type": "boolean" }, + "appServicePlan": { + "description": "Specify app service plan that will own restored site.", + "type": "string" + }, "operationType": { "description": "Operation type.", "default": "Default", @@ -15389,8 +20012,168 @@ } } }, - "SiteConfigResourceCollection": { - "description": "Collection of site configurations.", + "SiteConfigResourceCollection": { + "description": "Collection of site configurations.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteConfigResource" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string" + } + } + }, + "SiteConfigurationSnapshotInfo": { + "description": "A snapshot of a web app configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteConfigurationSnapshotInfo resource specific properties", + "properties": { + "time": { + "format": "date-time", + "description": "The time the snapshot was taken.", + "type": "string", + "readOnly": true + }, + "id": { + "format": "int32", + "description": "The id of the snapshot", + "type": "integer", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteExtensionInfo": { + "description": "Site Extension Information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SiteExtensionInfo resource specific properties", + "properties": { + "id": { + "description": "Site extension ID.", + "type": "string" + }, + "title": { + "description": "Site extension title.", + "type": "string" + }, + "type": { + "description": "Site extension type.", + "enum": [ + "Gallery", + "WebRoot" + ], + "type": "string", + "x-ms-enum": { + "name": "SiteExtensionType", + "modelAsString": false + } + }, + "summary": { + "description": "Summary description.", + "type": "string" + }, + "description": { + "description": "Detailed description.", + "type": "string" + }, + "version": { + "description": "Version information.", + "type": "string" + }, + "extensionUrl": { + "description": "Extension URL.", + "type": "string" + }, + "projectUrl": { + "description": "Project URL.", + "type": "string" + }, + "iconUrl": { + "description": "Icon URL.", + "type": "string" + }, + "licenseUrl": { + "description": "License URL.", + "type": "string" + }, + "feedUrl": { + "description": "Feed URL.", + "type": "string" + }, + "authors": { + "description": "List of authors.", + "type": "array", + "items": { + "type": "string" + } + }, + "installationArgs": { + "description": "Installer command line parameters.", + "type": "string" + }, + "publishedDateTime": { + "format": "date-time", + "description": "Published timestamp.", + "type": "string" + }, + "downloadCount": { + "format": "int32", + "description": "Count of downloads.", + "type": "integer" + }, + "localIsLatestVersion": { + "description": "true if the local version is the latest version; false otherwise.", + "type": "boolean" + }, + "localPath": { + "description": "Local path.", + "type": "string" + }, + "installedDateTime": { + "format": "date-time", + "description": "Installed timestamp.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state.", + "type": "string" + }, + "comment": { + "description": "Site Extension comment.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteExtensionInfoCollection": { + "description": "Collection of Kudu site extension information elements.", "required": [ "value" ], @@ -15400,7 +20183,7 @@ "description": "Collection of resources.", "type": "array", "items": { - "$ref": "#/definitions/SiteConfigResource" + "$ref": "#/definitions/SiteExtensionInfo" } }, "nextLink": { @@ -15409,35 +20192,6 @@ } } }, - "SiteConfigurationSnapshotInfo": { - "description": "A snapshot of a web app configuration.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyOnlyResource" - } - ], - "properties": { - "properties": { - "description": "SiteConfigurationSnapshotInfo resource specific properties", - "properties": { - "time": { - "format": "date-time", - "description": "The time the snapshot was taken.", - "type": "string", - "readOnly": true - }, - "id": { - "format": "int32", - "description": "The id of the snapshot", - "type": "integer", - "readOnly": true - } - }, - "x-ms-client-flatten": true - } - } - }, "SiteInstance": { "description": "Instance of an app.", "type": "object", @@ -15992,6 +20746,217 @@ } } }, + "TriggeredJobHistory": { + "description": "Triggered Web Job History. List of Triggered Web Job Run Information elements.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "TriggeredJobHistory resource specific properties", + "properties": { + "triggeredJobRuns": { + "description": "List of triggered web job runs.", + "type": "array", + "items": { + "$ref": "#/definitions/TriggeredJobRun" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "TriggeredJobHistoryCollection": { + "description": "Collection of Kudu continuous web job information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/TriggeredJobHistory" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string" + } + } + }, + "TriggeredJobRun": { + "description": "Triggered Web Job Run Information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "TriggeredJobRun resource specific properties", + "properties": { + "id": { + "description": "Job ID.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "name": { + "description": "Job name.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Job status.", + "enum": [ + "Success", + "Failed", + "Error" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggeredWebJobStatus", + "modelAsString": false + } + }, + "startTime": { + "format": "date-time", + "description": "Start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time.", + "type": "string" + }, + "duration": { + "description": "Job duration.", + "type": "string" + }, + "outputUrl": { + "description": "Output URL.", + "type": "string" + }, + "errorUrl": { + "description": "Error URL.", + "type": "string" + }, + "url": { + "description": "Job URL.", + "type": "string" + }, + "jobName": { + "description": "Job name.", + "type": "string" + }, + "trigger": { + "description": "Job trigger.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "TriggeredWebJob": { + "description": "Triggered Web Job Information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "TriggeredWebJob resource specific properties", + "properties": { + "latestRun": { + "$ref": "#/definitions/TriggeredJobRun", + "description": "Latest job run information." + }, + "historyUrl": { + "description": "History URL.", + "type": "string" + }, + "schedulerLogsUrl": { + "description": "Scheduler Logs URL.", + "type": "string" + }, + "name": { + "description": "Job name. Used as job identifier in ARM resource URI.", + "type": "string", + "readOnly": true + }, + "runCommand": { + "description": "Run command.", + "type": "string" + }, + "url": { + "description": "Job URL.", + "type": "string" + }, + "extraInfoUrl": { + "description": "Extra Info URL.", + "type": "string" + }, + "jobType": { + "description": "Job type.", + "enum": [ + "Continuous", + "Triggered" + ], + "type": "string", + "x-ms-enum": { + "name": "WebJobType", + "modelAsString": false + } + }, + "error": { + "description": "Error information.", + "type": "string" + }, + "usingSdk": { + "description": "Using SDK?", + "type": "boolean" + }, + "settings": { + "description": "Job settings.", + "type": "object" + } + }, + "x-ms-client-flatten": true + } + } + }, + "TriggeredWebJobCollection": { + "description": "Collection of Kudu continuous web job information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/TriggeredWebJob" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string" + } + } + }, "User": { "description": "User crendentials used for publishing activity.", "type": "object", @@ -16244,6 +21209,84 @@ "type": "string" } } + }, + "WebJob": { + "description": "Web Job Information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "WebJob resource specific properties", + "properties": { + "name": { + "description": "Job name. Used as job identifier in ARM resource URI.", + "type": "string", + "readOnly": true + }, + "runCommand": { + "description": "Run command.", + "type": "string" + }, + "url": { + "description": "Job URL.", + "type": "string" + }, + "extraInfoUrl": { + "description": "Extra Info URL.", + "type": "string" + }, + "jobType": { + "description": "Job type.", + "enum": [ + "Continuous", + "Triggered" + ], + "type": "string", + "x-ms-enum": { + "name": "WebJobType", + "modelAsString": false + } + }, + "error": { + "description": "Error information.", + "type": "string" + }, + "usingSdk": { + "description": "Using SDK?", + "type": "boolean" + }, + "settings": { + "description": "Job settings.", + "type": "object" + } + }, + "x-ms-client-flatten": true + } + } + }, + "WebJobCollection": { + "description": "Collection of Kudu web job information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WebJob" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string" + } + } } }, "parameters": { @@ -16291,4 +21334,4 @@ ] } ] -} +} \ No newline at end of file