{ "swagger": "2.0", "info": { "version": "2018-11-01", "title": "WebApps API Client" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": { "get": { "tags": [ "WebApps" ], "summary": "Get all apps for a subscription.", "description": "Get all apps for a subscription.", "operationId": "WebApps_List", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/WebAppCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites": { "get": { "tags": [ "WebApps" ], "summary": "Gets all web, mobile, and API apps in the specified resource group.", "description": "Gets all web, mobile, and API apps in the specified resource group.", "operationId": "WebApps_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "includeSlots", "in": "query", "description": "Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps.", "type": "boolean" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/WebAppCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}": { "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_Get", "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": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "404": { "description": "Not found." } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", "operationId": "WebApps_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "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.", "required": true, "type": "string" }, { "name": "siteEnvelope", "in": "body", "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "202": { "description": "Asynchronous operation in progress.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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_Delete", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app to delete.", "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 false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.", "type": "boolean" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted web app." }, "204": { "description": "Successfully deleted web app." }, "404": { "description": "Web app not found." } } }, "patch": { "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_Update", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "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.", "required": true, "type": "string" }, { "name": "siteEnvelope", "in": "body", "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { "$ref": "#/definitions/SitePatchResource" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "202": { "description": "Asynchronous operation in progress.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname": { "get": { "tags": [ "WebApps" ], "summary": "Analyze a custom hostname.", "description": "Analyze a custom hostname.", "operationId": "WebApps_AnalyzeCustomHostname", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "hostName", "in": "query", "description": "Custom hostname.", "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomHostnameAnalysisResult" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig": { "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_ApplySlotConfigToProduction", "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." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": { "post": { "tags": [ "WebApps" ], "summary": "Creates a backup of an app.", "description": "Creates a backup of an app.", "operationId": "WebApps_Backup", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Backup configuration. You can use the JSON response from the POST action as input here.", "required": true, "schema": { "$ref": "#/definitions/BackupRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupItem" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": { "get": { "tags": [ "WebApps" ], "summary": "Gets existing backups of an app.", "description": "Gets existing backups of an app.", "operationId": "WebApps_ListBackups", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupItemCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a backup of an app by its ID.", "description": "Gets a backup of an app by its ID.", "operationId": "WebApps_GetBackupStatus", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "backupId", "in": "path", "description": "ID of the backup.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupItem" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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_DeleteBackup", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "backupId", "in": "path", "description": "ID of the backup.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted web app backup item." }, "404": { "description": "Web app backup item does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", "description": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", "operationId": "WebApps_ListBackupStatusSecrets", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "backupId", "in": "path", "description": "ID of backup.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Information on backup request.", "required": true, "schema": { "$ref": "#/definitions/BackupRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupItem" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore": { "post": { "tags": [ "WebApps" ], "summary": "Restores a specific backup to another app (or deployment slot, if specified).", "description": "Restores a specific backup to another app (or deployment slot, if specified).", "operationId": "WebApps_Restore", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "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" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "202": { "description": "Restore operation started." }, "200": { "description": "Restore operation started." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config": { "get": { "tags": [ "WebApps" ], "summary": "List the configurations of an app", "description": "List the configurations of an app", "operationId": "WebApps_ListConfigurations", "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/SiteConfigResourceCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings": { "put": { "tags": [ "WebApps" ], "summary": "Replaces the application settings of an app.", "description": "Replaces the application settings of an app.", "operationId": "WebApps_UpdateApplicationSettings", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "appSettings", "in": "body", "description": "Application settings of the app.", "required": true, "schema": { "$ref": "#/definitions/StringDictionary" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the application settings of an app.", "description": "Gets the application settings of an app.", "operationId": "WebApps_ListApplicationSettings", "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/StringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": { "put": { "tags": [ "WebApps" ], "summary": "Updates the Authentication / Authorization settings associated with web app.", "description": "Updates the Authentication / Authorization settings associated with web app.", "operationId": "WebApps_UpdateAuthSettings", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteAuthSettings" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the Authentication/Authorization settings of an app.", "description": "Gets the Authentication/Authorization settings of an app.", "operationId": "WebApps_GetAuthSettings", "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/SiteAuthSettings" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts": { "put": { "tags": [ "WebApps" ], "summary": "Updates the Azure storage account configurations of an app.", "description": "Updates the Azure storage account configurations of an app.", "operationId": "WebApps_UpdateAzureStorageAccounts", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "azureStorageAccounts", "in": "body", "description": "Azure storage accounts of the app.", "required": true, "schema": { "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the Azure storage account configurations of an app.", "description": "Gets the Azure storage account configurations of an app.", "operationId": "WebApps_ListAzureStorageAccounts", "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/AzureStoragePropertyDictionaryResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": { "put": { "tags": [ "WebApps" ], "summary": "Updates the backup configuration of an app.", "description": "Updates the backup configuration of an app.", "operationId": "WebApps_UpdateBackupConfiguration", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Edited backup configuration.", "required": true, "schema": { "$ref": "#/definitions/BackupRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupRequest" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes the backup configuration of an app.", "description": "Deletes the backup configuration of an app.", "operationId": "WebApps_DeleteBackupConfiguration", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted backup configuration." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the backup configuration of an app.", "description": "Gets the backup configuration of an app.", "operationId": "WebApps_GetBackupConfiguration", "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/BackupRequest" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": { "put": { "tags": [ "WebApps" ], "summary": "Replaces the connection strings of an app.", "description": "Replaces the connection strings of an app.", "operationId": "WebApps_UpdateConnectionStrings", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "connectionStrings", "in": "body", "description": "Connection strings of the app or deployment slot. See example.", "required": true, "schema": { "$ref": "#/definitions/ConnectionStringDictionary" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConnectionStringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the connection strings of an app.", "description": "Gets the connection strings of an app.", "operationId": "WebApps_ListConnectionStrings", "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/ConnectionStringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": { "get": { "tags": [ "WebApps" ], "summary": "Gets the logging configuration of an app.", "description": "Gets the logging configuration of an app.", "operationId": "WebApps_GetDiagnosticLogsConfiguration", "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/SiteLogsConfig" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates the logging configuration of an app.", "description": "Updates the logging configuration of an app.", "operationId": "WebApps_UpdateDiagnosticLogsConfig", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "siteLogsConfig", "in": "body", "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", "required": true, "schema": { "$ref": "#/definitions/SiteLogsConfig" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteLogsConfig" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": { "put": { "tags": [ "WebApps" ], "summary": "Replaces the metadata of an app.", "description": "Replaces the metadata of an app.", "operationId": "WebApps_UpdateMetadata", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "metadata", "in": "body", "description": "Edited metadata of the app or deployment slot. See example.", "required": true, "schema": { "$ref": "#/definitions/StringDictionary" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the metadata of an app.", "description": "Gets the metadata of an app.", "operationId": "WebApps_ListMetadata", "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/StringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/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_ListPublishingCredentials", "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": "../2018-02-01/CommonDefinitions.json#/definitions/User" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings": { "put": { "tags": [ "WebApps" ], "summary": "Updates the Push settings associated with web app.", "description": "Updates the Push settings associated with web app.", "operationId": "WebApps_UpdateSitePushSettings", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "pushSettings", "in": "body", "description": "Push settings associated with web app.", "required": true, "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/PushSettings" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/PushSettings" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the Push settings associated with web app.", "description": "Gets the Push settings associated with web app.", "operationId": "WebApps_ListSitePushSettings", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/PushSettings" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames": { "get": { "tags": [ "WebApps" ], "summary": "Gets the names of app settings and connection strings that stick to the slot (not swapped).", "description": "Gets the names of app settings and connection strings that stick to the slot (not swapped).", "operationId": "WebApps_ListSlotConfigurationNames", "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/SlotConfigNamesResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates the names of application settings and connection string that remain with the slot during swap operation.", "description": "Updates the names of application settings and connection string that remain with the slot during swap operation.", "operationId": "WebApps_UpdateSlotConfigurationNames", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "slotConfigNames", "in": "body", "description": "Names of application settings and connection strings. See example.", "required": true, "schema": { "$ref": "#/definitions/SlotConfigNamesResource" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SlotConfigNamesResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": { "get": { "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_GetConfiguration", "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/SiteConfigResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates the configuration of an app.", "description": "Updates the configuration of an app.", "operationId": "WebApps_CreateOrUpdateConfiguration", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "siteConfig", "in": "body", "description": "JSON representation of a SiteConfig object. See example.", "required": true, "schema": { "$ref": "#/definitions/SiteConfigResource" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "patch": { "tags": [ "WebApps" ], "summary": "Updates the configuration of an app.", "description": "Updates the configuration of an app.", "operationId": "WebApps_UpdateConfiguration", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "siteConfig", "in": "body", "description": "JSON representation of a SiteConfig object. See example.", "required": true, "schema": { "$ref": "#/definitions/SiteConfigResource" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots": { "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_ListConfigurationSnapshotInfo", "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/SiteConfigurationSnapshotInfoCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a snapshot of the configuration of an app at a previous point in time.", "description": "Gets a snapshot of the configuration of an app at a previous point in time.", "operationId": "WebApps_GetConfigurationSnapshot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover": { "post": { "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_RecoverSiteConfigurationSnapshot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "No Content" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs": { "post": { "tags": [ "WebApps" ], "summary": "Gets the last lines of docker logs for the given site", "description": "Gets the last lines of docker logs for the given site", "operationId": "WebApps_GetWebSiteContainerLogs", "produces": [ "application/octet-stream" ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "No Content" }, "200": { "description": "OK", "schema": { "type": "file" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download": { "post": { "tags": [ "WebApps" ], "summary": "Gets the ZIP archived docker log files for the given site", "description": "Gets the ZIP archived docker log files for the given site", "operationId": "WebApps_GetContainerLogsZip", "produces": [ "application/zip" ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "No Content" }, "200": { "description": "OK", "schema": { "type": "file" } } } } }, "/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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "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": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully 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": "webJobName", "in": "path", "description": "Name of Web Job.", "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": "webJobName", "in": "path", "description": "Name of Web Job.", "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.", "description": "List deployments for an app, or a deployment slot.", "operationId": "WebApps_ListDeployments", "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/DeploymentCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}": { "get": { "tags": [ "WebApps" ], "summary": "Get a deployment by its ID for an app, or a deployment slot.", "description": "Get a deployment by its ID for an app, or a deployment slot.", "operationId": "WebApps_GetDeployment", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "Deployment ID.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Deployment" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Create a deployment for an app, or a deployment slot.", "description": "Create a deployment for an app, or a deployment slot.", "operationId": "WebApps_CreateDeployment", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "ID of an existing deployment.", "required": true, "type": "string" }, { "name": "deployment", "in": "body", "description": "Deployment details.", "required": true, "schema": { "$ref": "#/definitions/Deployment" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Deployment" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Delete a deployment by its ID for an app, or a deployment slot.", "description": "Delete a deployment by its ID for an app, or a deployment slot.", "operationId": "WebApps_DeleteDeployment", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "Deployment ID.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted deployment." }, "204": { "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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup": { "post": { "tags": [ "WebApps" ], "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", "description": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", "operationId": "WebApps_DiscoverBackup", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", "required": true, "schema": { "$ref": "#/definitions/RestoreRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RestoreRequest" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers": { "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_ListDomainOwnershipIdentifiers", "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": "../2018-02-01/CommonDefinitions.json#/definitions/IdentifierCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { "get": { "tags": [ "WebApps" ], "summary": "Get domain ownership identifier for web app.", "description": "Get domain ownership identifier for web app.", "operationId": "WebApps_GetDomainOwnershipIdentifier", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "domainOwnershipIdentifierName", "in": "path", "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", "description": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifier", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a domain ownership identifier for a web app.", "description": "Deletes a domain ownership identifier for a web app.", "operationId": "WebApps_DeleteDomainOwnershipIdentifier", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "domainOwnershipIdentifierName", "in": "path", "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted domain ownership identifier." }, "204": { "description": "Domain ownership identifier does not exist." } } }, "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_UpdateDomainOwnershipIdentifier", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], "summary": "Get the status of the last MSDeploy operation.", "description": "Get the status of the last MSDeploy operation.", "operationId": "WebApps_GetMSDeployStatus", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Invoke the MSDeploy web app extension.", "description": "Invoke the MSDeploy web app extension.", "operationId": "WebApps_CreateMSDeployOperation", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "MSDeploy", "in": "body", "description": "Details of MSDeploy operation", "required": true, "schema": { "$ref": "#/definitions/MSDeploy" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "201": { "description": "Deployment is scheduled.", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "409": { "description": "Another deployment is in progress." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log": { "get": { "tags": [ "WebApps" ], "summary": "Get the MSDeploy Log for the last MSDeploy operation.", "description": "Get the MSDeploy Log for the last MSDeploy operation.", "operationId": "WebApps_GetMSDeployLog", "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": "MSDeploy log returned.", "schema": { "$ref": "#/definitions/MSDeployLog" } }, "404": { "description": "MSDeploy log not found." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions": { "get": { "tags": [ "WebApps" ], "summary": "List the functions for a web site, or a deployment slot.", "description": "List the functions for a web site, or a deployment slot.", "operationId": "WebApps_ListFunctions", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "WebApps" ], "summary": "Delete a function for web site, or a deployment slot.", "description": "Delete a function for web site, or a deployment slot.", "operationId": "WebApps_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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { "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_ListHostNameBindings", "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/HostNameBindingCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { "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_GetHostNameBinding", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "hostName", "in": "path", "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HostNameBinding" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a hostname binding for an app.", "description": "Creates a hostname binding for an app.", "operationId": "WebApps_CreateOrUpdateHostNameBinding", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "hostName", "in": "path", "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, { "name": "hostNameBinding", "in": "body", "description": "Binding details. This is the JSON representation of a HostNameBinding object.", "required": true, "schema": { "$ref": "#/definitions/HostNameBinding" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HostNameBinding" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a hostname binding for an app.", "description": "Deletes a hostname binding for an app.", "operationId": "WebApps_DeleteHostNameBinding", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "hostName", "in": "path", "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { "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_GetHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a new Hybrid Connection using a Service Bus relay.", "description": "Creates a new Hybrid Connection using a Service Bus relay.", "operationId": "WebApps_CreateOrUpdateHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", "description": "The details of the hybrid connection.", "required": true, "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Removes a Hybrid Connection from this site.", "description": "Removes a Hybrid Connection from this site.", "operationId": "WebApps_DeleteHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted hybrid connection." }, "404": { "description": "Hybrid connection does not exist." } } }, "patch": { "tags": [ "WebApps" ], "summary": "Creates a new Hybrid Connection using a Service Bus relay.", "description": "Creates a new Hybrid Connection using a Service Bus relay.", "operationId": "WebApps_UpdateHybridConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", "description": "The details of the hybrid connection.", "required": true, "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { "post": { "tags": [ "WebApps" ], "summary": "Gets the send key name and value for a Hybrid Connection.", "description": "Gets the send key name and value for a Hybrid Connection.", "operationId": "WebApps_ListHybridConnectionKeys", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnectionKey" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": { "get": { "tags": [ "WebApps" ], "summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.", "description": "Retrieves all Service Bus Hybrid Connections used by this Web App.", "operationId": "WebApps_ListHybridConnections", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { "get": { "tags": [ "WebApps" ], "summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).", "description": "Gets hybrid connections configured for an app (or deployment slot, if specified).", "operationId": "WebApps_ListRelayServiceConnections", "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/RelayServiceConnectionEntity" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a hybrid connection configuration by its name.", "description": "Gets a hybrid connection configuration by its name.", "operationId": "WebApps_GetRelayServiceConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "entityName", "in": "path", "description": "Name of the hybrid connection.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", "description": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).", "operationId": "WebApps_CreateOrUpdateRelayServiceConnection", "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": "connectionEnvelope", "in": "body", "description": "Details of the hybrid connection configuration.", "required": true, "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a relay service connection by its name.", "description": "Deletes a relay service connection by its name.", "operationId": "WebApps_DeleteRelayServiceConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "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" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully 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_UpdateRelayServiceConnection", "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": "connectionEnvelope", "in": "body", "description": "Details of the hybrid connection configuration.", "required": true, "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { "get": { "tags": [ "WebApps" ], "summary": "Gets all scale-out instances of an app.", "description": "Gets all scale-out instances of an app.", "operationId": "WebApps_ListInstanceIdentifiers", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "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/WebAppInstanceCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], "summary": "Get the status of the last MSDeploy operation.", "description": "Get the status of the last MSDeploy operation.", "operationId": "WebApps_GetInstanceMsDeployStatus", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of web app instance.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Invoke the MSDeploy web app extension.", "description": "Invoke the MSDeploy web app extension.", "operationId": "WebApps_CreateInstanceMSDeployOperation", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of web app instance.", "required": true, "type": "string" }, { "name": "MSDeploy", "in": "body", "description": "Details of MSDeploy operation", "required": true, "schema": { "$ref": "#/definitions/MSDeploy" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "201": { "description": "Deployment is scheduled.", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "409": { "description": "Another deployment is in progress." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": { "get": { "tags": [ "WebApps" ], "summary": "Get the MSDeploy Log for the last MSDeploy operation.", "description": "Get the MSDeploy Log for the last MSDeploy operation.", "operationId": "WebApps_GetInstanceMSDeployLog", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of web app instance.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "MSDeploy log returned.", "schema": { "$ref": "#/definitions/MSDeployLog" } }, "404": { "description": "MSDeploy log not found." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": { "get": { "tags": [ "WebApps" ], "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", "description": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListInstanceProcesses", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Process terminated.", "schema": { "$ref": "#/definitions/ProcessInfoCollection" } }, "404": { "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": { "get": { "tags": [ "WebApps" ], "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", "description": "Get process information by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetInstanceProcess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Process information returned.", "schema": { "$ref": "#/definitions/ProcessInfo" } }, "404": { "description": "Process with the specified ID is not running." } } }, "delete": { "tags": [ "WebApps" ], "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", "operationId": "WebApps_DeleteInstanceProcess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "Process terminated." }, "404": { "description": "Process with the specified ID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": { "get": { "tags": [ "WebApps" ], "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetInstanceProcessDump", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } }, "404": { "description": "Process with the specified ID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": { "get": { "tags": [ "WebApps" ], "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListInstanceProcessModules", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Module information returned.", "schema": { "$ref": "#/definitions/ProcessModuleInfoCollection" } }, "404": { "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": { "get": { "tags": [ "WebApps" ], "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", "description": "Get process information by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetInstanceProcessModule", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "baseAddress", "in": "path", "description": "Module base address.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Module information returned.", "schema": { "$ref": "#/definitions/ProcessModuleInfo" } }, "404": { "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": { "get": { "tags": [ "WebApps" ], "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListInstanceProcessThreads", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Thread information returned.", "schema": { "$ref": "#/definitions/ProcessThreadInfoCollection" } }, "404": { "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads/{threadId}": { "get": { "tags": [ "WebApps" ], "summary": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", "description": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", "operationId": "WebApps_GetInstanceProcessThread", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "threadId", "in": "path", "description": "TID.", "required": true, "type": "string" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Thread information returned.", "schema": { "$ref": "#/definitions/ProcessThreadInfo" } }, "404": { "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { "post": { "tags": [ "WebApps" ], "summary": "Shows whether an app can be cloned to another resource group or subscription.", "description": "Shows whether an app can be cloned to another resource group or subscription.", "operationId": "WebApps_IsCloneable", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/SiteCloneability" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { "get": { "tags": [ "WebApps" ], "summary": "Gets all metric definitions of an app (or deployment slot, if specified).", "description": "Gets all metric definitions of an app (or deployment slot, if specified).", "operationId": "WebApps_ListMetricDefinitions", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { "get": { "tags": [ "WebApps" ], "summary": "Gets performance metrics of an app (or deployment slot, if specified).", "description": "Gets performance metrics of an app (or deployment slot, if specified).", "operationId": "WebApps_ListMetrics", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "details", "in": "query", "description": "Specify \"true\" to include metric details in the response. It is \"false\" by default.", "type": "boolean" }, { "name": "$filter", "in": "query", "description": "Return only metrics specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", "type": "string", "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ResourceMetricCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": { "put": { "tags": [ "WebApps" ], "summary": "Restores a web app.", "description": "Restores a web app.", "operationId": "WebApps_MigrateStorage", "parameters": [ { "name": "subscriptionName", "in": "query", "description": "Azure subscription.", "required": true, "type": "string" }, { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "migrationOptions", "in": "body", "description": "Migration migrationOptions.", "required": true, "schema": { "$ref": "#/definitions/StorageMigrationOptions" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StorageMigrationResponse" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": { "post": { "tags": [ "WebApps" ], "summary": "Migrates a local (in-app) MySql database to a remote MySql database.", "description": "Migrates a local (in-app) MySql database to a remote MySql database.", "operationId": "WebApps_MigrateMySql", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "migrationRequestEnvelope", "in": "body", "description": "MySql migration options.", "required": true, "schema": { "$ref": "#/definitions/MigrateMySqlRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Operation" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": { "get": { "tags": [ "WebApps" ], "summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", "description": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", "operationId": "WebApps_GetMigrateMySqlStatus", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MigrateMySqlStatus" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": { "get": { "tags": [ "WebApps" ], "summary": "Gets a Swift Virtual Network connection.", "description": "Gets a Swift Virtual Network connection.", "operationId": "WebApps_GetSwiftVirtualNetworkConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/SwiftVirtualNetwork" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", "description": "Properties of the Virtual Network connection. See example.", "required": true, "schema": { "$ref": "#/definitions/SwiftVirtualNetwork" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SwiftVirtualNetwork" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", "description": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", "operationId": "WebApps_DeleteSwiftVirtualNetwork", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted virtual network." }, "404": { "description": "Virtual network does not exist." } } }, "patch": { "tags": [ "WebApps" ], "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", "operationId": "WebApps_UpdateSwiftVirtualNetworkConnection", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", "description": "Properties of the Virtual Network connection. See example.", "required": true, "schema": { "$ref": "#/definitions/SwiftVirtualNetwork" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SwiftVirtualNetwork" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { "get": { "tags": [ "WebApps" ], "summary": "Gets all network features used by the app (or deployment slot, if specified).", "description": "Gets all network features used by the app (or deployment slot, if specified).", "operationId": "WebApps_ListNetworkFeatures", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "view", "in": "path", "description": "The type of view. This can either be \"summary\" or \"detailed\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/NetworkFeatures" } }, "404": { "description": "The requested view does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "operationId": "WebApps_GetNetworkTraceOperation", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "operationId", "in": "path", "description": "GUID of the operation.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "202": { "description": "Operation is in progress.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get the current status of a network trace operation for a site": { "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": { "post": { "tags": [ "WebApps" ], "summary": "Start capturing network packets for the site (To be deprecated).", "description": "Start capturing network packets for the site (To be deprecated).", "operationId": "WebApps_StartWebSiteNetworkTrace", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "durationInSeconds", "in": "query", "description": "The duration to keep capturing in seconds.", "type": "integer", "format": "int32" }, { "name": "maxFrameLength", "in": "query", "description": "The maximum frame length in bytes (Optional).", "type": "integer", "format": "int32" }, { "name": "sasUrl", "in": "query", "description": "The Blob URL to store capture file.", "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": { "post": { "tags": [ "WebApps" ], "summary": "Start capturing network packets for the site.", "description": "Start capturing network packets for the site.", "operationId": "WebApps_StartWebSiteNetworkTraceOperation", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "durationInSeconds", "in": "query", "description": "The duration to keep capturing in seconds.", "type": "integer", "format": "int32" }, { "name": "maxFrameLength", "in": "query", "description": "The maximum frame length in bytes (Optional).", "type": "integer", "format": "int32" }, { "name": "sasUrl", "in": "query", "description": "The Blob URL to store capture file.", "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "202": { "description": "Operation is in progress.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Start a new network trace operation for a site": { "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": { "post": { "tags": [ "WebApps" ], "summary": "Stop ongoing capturing network packets for the site.", "description": "Stop ongoing capturing network packets for the site.", "operationId": "WebApps_StopWebSiteNetworkTrace", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Stopped." }, "204": { "description": "Stopped." } }, "x-ms-examples": { "Stop a currently running network trace operation for a site": { "$ref": "./examples/StopWebSiteNetworkTrace.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "operationId": "WebApps_GetNetworkTraces", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "operationId", "in": "path", "description": "GUID of the operation.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get NetworkTraces for a site": { "$ref": "./examples/GetWebSiteNetworkTraces.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "operationId": "WebApps_GetNetworkTraceOperationV2", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "operationId", "in": "path", "description": "GUID of the operation.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "202": { "description": "Operation is in progress.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get the current status of a network trace operation for a site": { "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "operationId": "WebApps_GetNetworkTracesV2", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "operationId", "in": "path", "description": "GUID of the operation.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get NetworkTraces for a site": { "$ref": "./examples/GetWebSiteNetworkTraces.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { "post": { "tags": [ "WebApps" ], "summary": "Generates a new publishing password for an app (or deployment slot, if specified).", "description": "Generates a new publishing password for an app (or deployment slot, if specified).", "operationId": "WebApps_GenerateNewSitePublishingPassword", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully generate new password." }, "204": { "description": "Successfully generate new password." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": { "get": { "tags": [ "WebApps" ], "summary": "Gets perfmon counters for web app.", "description": "Gets perfmon counters for web app.", "operationId": "WebApps_ListPerfMonCounters", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", "type": "string", "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PerfMonCounterCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": { "get": { "tags": [ "WebApps" ], "summary": "Gets web app's event logs.", "description": "Gets web app's event logs.", "operationId": "WebApps_GetSitePhpErrorLogFlag", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SitePhpErrorLogFlag" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { "get": { "tags": [ "WebApps" ], "summary": "Gets the premier add-ons of an app.", "description": "Gets the premier add-ons of an app.", "operationId": "WebApps_ListPremierAddOns", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PremierAddOn" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named add-on of an app.", "description": "Gets a named add-on of an app.", "operationId": "WebApps_GetPremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "premierAddOnName", "in": "path", "description": "Add-on name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PremierAddOn" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates a named add-on of an app.", "description": "Updates a named add-on of an app.", "operationId": "WebApps_AddPremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "premierAddOnName", "in": "path", "description": "Add-on name.", "required": true, "type": "string" }, { "name": "premierAddOn", "in": "body", "description": "A JSON representation of the edited premier add-on.", "required": true, "schema": { "$ref": "#/definitions/PremierAddOn" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PremierAddOn" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Delete a premier add-on from an app.", "description": "Delete a premier add-on from an app.", "operationId": "WebApps_DeletePremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "premierAddOnName", "in": "path", "description": "Add-on name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted premier add-on." } } }, "patch": { "tags": [ "WebApps" ], "summary": "Updates a named add-on of an app.", "description": "Updates a named add-on of an app.", "operationId": "WebApps_UpdatePremierAddOn", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "premierAddOnName", "in": "path", "description": "Add-on name.", "required": true, "type": "string" }, { "name": "premierAddOn", "in": "body", "description": "A JSON representation of the edited premier add-on.", "required": true, "schema": { "$ref": "#/definitions/PremierAddOnPatchResource" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PremierAddOn" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { "get": { "tags": [ "WebApps" ], "summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", "description": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", "operationId": "WebApps_GetPrivateAccess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivateAccess" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", "description": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", "operationId": "WebApps_PutPrivateAccessVnet", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "access", "in": "body", "description": "The information for the private access", "required": true, "schema": { "$ref": "#/definitions/PrivateAccess" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivateAccess" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": { "get": { "tags": [ "WebApps" ], "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", "description": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListProcesses", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Process terminated.", "schema": { "$ref": "#/definitions/ProcessInfoCollection" } }, "404": { "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": { "get": { "tags": [ "WebApps" ], "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", "description": "Get process information by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetProcess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Process information returned.", "schema": { "$ref": "#/definitions/ProcessInfo" } }, "404": { "description": "Process with the specified ID is not running." } } }, "delete": { "tags": [ "WebApps" ], "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", "operationId": "WebApps_DeleteProcess", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "Process terminated." }, "404": { "description": "Process with the specified ID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": { "get": { "tags": [ "WebApps" ], "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetProcessDump", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } }, "404": { "description": "Process with the specified ID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": { "get": { "tags": [ "WebApps" ], "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListProcessModules", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Module information returned.", "schema": { "$ref": "#/definitions/ProcessModuleInfoCollection" } }, "404": { "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}": { "get": { "tags": [ "WebApps" ], "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", "description": "Get process information by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetProcessModule", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "baseAddress", "in": "path", "description": "Module base address.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Module information returned.", "schema": { "$ref": "#/definitions/ProcessModuleInfo" } }, "404": { "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": { "get": { "tags": [ "WebApps" ], "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListProcessThreads", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "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}/processes/{processId}/threads/{threadId}": { "get": { "tags": [ "WebApps" ], "summary": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", "description": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", "operationId": "WebApps_GetProcessThread", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "threadId", "in": "path", "description": "TID.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Thread information returned.", "schema": { "$ref": "#/definitions/ProcessThreadInfo" } }, "404": { "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": { "get": { "tags": [ "WebApps" ], "summary": "Get public certificates for an app or a deployment slot.", "description": "Get public certificates for an app or a deployment slot.", "operationId": "WebApps_ListPublicCertificates", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicCertificateCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": { "get": { "tags": [ "WebApps" ], "summary": "Get the named public certificate for an app (or deployment slot, if specified).", "description": "Get the named public certificate for an app (or deployment slot, if specified).", "operationId": "WebApps_GetPublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "publicCertificateName", "in": "path", "description": "Public certificate name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicCertificate" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a hostname binding for an app.", "description": "Creates a hostname binding for an app.", "operationId": "WebApps_CreateOrUpdatePublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "publicCertificateName", "in": "path", "description": "Public certificate name.", "required": true, "type": "string" }, { "name": "publicCertificate", "in": "body", "description": "Public certificate details. This is the JSON representation of a PublicCertificate object.", "required": true, "schema": { "$ref": "#/definitions/PublicCertificate" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicCertificate" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a hostname binding for an app.", "description": "Deletes a hostname binding for an app.", "operationId": "WebApps_DeletePublicCertificate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "publicCertificateName", "in": "path", "description": "Public certificate name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { "post": { "tags": [ "WebApps" ], "summary": "Gets the publishing profile for an app (or deployment slot, if specified).", "description": "Gets the publishing profile for an app (or deployment slot, if specified).", "operationId": "WebApps_ListPublishingProfileXmlWithSecrets", "produces": [ "application/xml" ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "publishingProfileOptions", "in": "body", "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", "required": true, "schema": { "$ref": "#/definitions/CsmPublishingProfileOptions" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { "post": { "tags": [ "WebApps" ], "summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", "description": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.", "operationId": "WebApps_ResetProductionSlotConfig", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { "post": { "tags": [ "WebApps" ], "summary": "Restarts an app (or deployment slot, if specified).", "description": "Restarts an app (or deployment slot, if specified).", "operationId": "WebApps_Restart", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "softRestart", "in": "query", "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", "type": "boolean" }, { "name": "synchronous", "in": "query", "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", "type": "boolean" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully restarted app." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": { "post": { "tags": [ "WebApps" ], "summary": "Restores an app from a backup blob in Azure Storage.", "description": "Restores an app from a backup blob in Azure Storage.", "operationId": "WebApps_RestoreFromBackupBlob", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Information on restore request .", "required": true, "schema": { "$ref": "#/definitions/RestoreRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "202": { "description": "Restore operation started." }, "200": { "description": "Restore operation started." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { "post": { "tags": [ "WebApps" ], "summary": "Restores a deleted web app to this web app.", "description": "Restores a deleted web app to this web app.", "operationId": "WebApps_RestoreFromDeletedApp", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "restoreRequest", "in": "body", "description": "Deleted web app restore information.", "required": true, "schema": { "$ref": "#/definitions/DeletedAppRestoreRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "202": { "description": "Restore operation started." }, "200": { "description": "Restore operation started." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": { "post": { "tags": [ "WebApps" ], "summary": "Restores a web app from a snapshot.", "description": "Restores a web app from a snapshot.", "operationId": "WebApps_RestoreSnapshot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "restoreRequest", "in": "body", "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", "required": true, "schema": { "$ref": "#/definitions/SnapshotRestoreRequest" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "202": { "description": "Restore operation started." }, "200": { "description": "Restore operation started." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": { "get": { "tags": [ "WebApps" ], "summary": "Get list of siteextensions for a web site, or a deployment slot.", "description": "Get list of siteextensions for a web site, or a deployment slot.", "operationId": "WebApps_ListSiteExtensions", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "SiteExtension information returned.", "schema": { "$ref": "#/definitions/SiteExtensionInfoCollection" } }, "404": { "description": "SiteExtension not found." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": { "get": { "tags": [ "WebApps" ], "summary": "Get site extension information by its ID for a web site, or a deployment slot.", "description": "Get site extension information by its ID for a web site, or a deployment slot.", "operationId": "WebApps_GetSiteExtension", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "siteExtensionId", "in": "path", "description": "Site extension name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "SiteExtension information returned.", "schema": { "$ref": "#/definitions/SiteExtensionInfo" } }, "404": { "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } }, "put": { "tags": [ "WebApps" ], "summary": "Install site extension on a web site, or a deployment slot.", "description": "Install site extension on a web site, or a deployment slot.", "operationId": "WebApps_InstallSiteExtension", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "siteExtensionId", "in": "path", "description": "Site extension name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "201": { "description": "Site Extension created.", "schema": { "$ref": "#/definitions/SiteExtensionInfo" } }, "200": { "description": "Site Extension created.", "schema": { "$ref": "#/definitions/SiteExtensionInfo" } }, "429": { "description": "Site Extension is being installed on another request: Rejecting current request." } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "WebApps" ], "summary": "Remove a site extension from a web site, or a deployment slot.", "description": "Remove a site extension from a web site, or a deployment slot.", "operationId": "WebApps_DeleteSiteExtension", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "siteExtensionId", "in": "path", "description": "Site extension name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "SiteExtension terminated." }, "404": { "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { "get": { "tags": [ "WebApps" ], "summary": "Gets an app's deployment slots.", "description": "Gets an app's deployment slots.", "operationId": "WebApps_ListSlots", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/WebAppCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "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. By default, this API returns the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "404": { "description": "Not found." } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", "operationId": "WebApps_CreateOrUpdateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "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.", "required": true, "type": "string" }, { "name": "siteEnvelope", "in": "body", "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot to create or update. The name 'production' is reserved.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "202": { "description": "Asynchronous operation in progress.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app to delete.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.", "required": true, "type": "string" }, { "name": "deleteMetrics", "in": "query", "description": "If true, web app metrics are also deleted.", "type": "boolean" }, { "name": "deleteEmptyServerFarm", "in": "query", "description": "Specify true if the App Service plan will be empty after app deletion and you want to delete the empty App Service plan. By default, the empty App Service plan is not deleted.", "type": "boolean" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted web app." }, "204": { "description": "Successfully deleted web app." }, "404": { "description": "Web app not found." } } }, "patch": { "tags": [ "WebApps" ], "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", "description": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.", "operationId": "WebApps_UpdateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "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.", "required": true, "type": "string" }, { "name": "siteEnvelope", "in": "body", "description": "A JSON representation of the app properties. See example.", "required": true, "schema": { "$ref": "#/definitions/SitePatchResource" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot to create or update. The name 'production' is reserved.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "202": { "description": "Asynchronous operation in progress.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Site" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": { "get": { "tags": [ "WebApps" ], "summary": "Analyze a custom hostname.", "description": "Analyze a custom hostname.", "operationId": "WebApps_AnalyzeCustomHostnameSlot", "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" }, { "name": "hostName", "in": "query", "description": "Custom hostname.", "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomHostnameAnalysisResult" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { "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", "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" } }, { "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." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { "post": { "tags": [ "WebApps" ], "summary": "Creates a backup of an app.", "description": "Creates a backup of an app.", "operationId": "WebApps_BackupSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Backup configuration. You can use the JSON response from the POST action as input here.", "required": true, "schema": { "$ref": "#/definitions/BackupRequest" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupItem" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { "get": { "tags": [ "WebApps" ], "summary": "Gets existing backups of an app.", "description": "Gets existing backups of an app.", "operationId": "WebApps_ListBackupsSlot", "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 backups of the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupItemCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a backup of an app by its ID.", "description": "Gets a backup of an app by its ID.", "operationId": "WebApps_GetBackupStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "backupId", "in": "path", "description": "ID of the backup.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupItem" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "backupId", "in": "path", "description": "ID of the backup.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully 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}/backups/{backupId}/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", "description": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", "operationId": "WebApps_ListBackupStatusSecretsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "backupId", "in": "path", "description": "ID of backup.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Information on backup request.", "required": true, "schema": { "$ref": "#/definitions/BackupRequest" } }, { "name": "slot", "in": "path", "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupItem" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { "post": { "tags": [ "WebApps" ], "summary": "Restores a specific backup to another app (or deployment slot, if specified).", "description": "Restores a specific backup to another app (or deployment slot, if specified).", "operationId": "WebApps_RestoreSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "backupId", "in": "path", "description": "ID of the backup.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Information on restore request .", "required": true, "schema": { "$ref": "#/definitions/RestoreRequest" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "202": { "description": "Restore operation started." }, "200": { "description": "Restore operation started." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": { "get": { "tags": [ "WebApps" ], "summary": "List the configurations of an app", "description": "List the configurations of an app", "operationId": "WebApps_ListConfigurationsSlot", "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 return configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigResourceCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { "put": { "tags": [ "WebApps" ], "summary": "Replaces the application settings of an app.", "description": "Replaces the application settings of an app.", "operationId": "WebApps_UpdateApplicationSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "appSettings", "in": "body", "description": "Application settings of the app.", "required": true, "schema": { "$ref": "#/definitions/StringDictionary" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the application settings of an app.", "description": "Gets the application settings of an app.", "operationId": "WebApps_ListApplicationSettingsSlot", "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 application settings for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { "put": { "tags": [ "WebApps" ], "summary": "Updates the Authentication / Authorization settings associated with web app.", "description": "Updates the Authentication / Authorization settings associated with web app.", "operationId": "WebApps_UpdateAuthSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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 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": "OK", "schema": { "$ref": "#/definitions/SiteAuthSettings" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the Authentication/Authorization settings of an app.", "description": "Gets the Authentication/Authorization settings of an app.", "operationId": "WebApps_GetAuthSettingsSlot", "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 settings for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteAuthSettings" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": { "put": { "tags": [ "WebApps" ], "summary": "Updates the Azure storage account configurations of an app.", "description": "Updates the Azure storage account configurations of an app.", "operationId": "WebApps_UpdateAzureStorageAccountsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "azureStorageAccounts", "in": "body", "description": "Azure storage accounts of the app.", "required": true, "schema": { "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the Azure storage account configurations of an app.", "description": "Gets the Azure storage account configurations of an app.", "operationId": "WebApps_ListAzureStorageAccountsSlot", "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 update the Azure storage account configurations for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AzureStoragePropertyDictionaryResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { "put": { "tags": [ "WebApps" ], "summary": "Updates the backup configuration of an app.", "description": "Updates the backup configuration of an app.", "operationId": "WebApps_UpdateBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Edited backup configuration.", "required": true, "schema": { "$ref": "#/definitions/BackupRequest" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupRequest" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes the backup configuration of an app.", "description": "Deletes the backup configuration of an app.", "operationId": "WebApps_DeleteBackupConfigurationSlot", "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 backup configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted backup configuration." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the backup configuration of an app.", "description": "Gets the backup configuration of an app.", "operationId": "WebApps_GetBackupConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "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.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackupRequest" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { "put": { "tags": [ "WebApps" ], "summary": "Replaces the connection strings of an app.", "description": "Replaces the connection strings of an app.", "operationId": "WebApps_UpdateConnectionStringsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "connectionStrings", "in": "body", "description": "Connection strings of the app or deployment slot. See example.", "required": true, "schema": { "$ref": "#/definitions/ConnectionStringDictionary" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConnectionStringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the connection strings of an app.", "description": "Gets the connection strings of an app.", "operationId": "WebApps_ListConnectionStringsSlot", "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 connection settings for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConnectionStringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { "get": { "tags": [ "WebApps" ], "summary": "Gets the logging configuration of an app.", "description": "Gets the logging configuration of an app.", "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot", "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 logging configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteLogsConfig" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates the logging configuration of an app.", "description": "Updates the logging configuration of an app.", "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "siteLogsConfig", "in": "body", "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.", "required": true, "schema": { "$ref": "#/definitions/SiteLogsConfig" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteLogsConfig" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { "put": { "tags": [ "WebApps" ], "summary": "Replaces the metadata of an app.", "description": "Replaces the metadata of an app.", "operationId": "WebApps_UpdateMetadataSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "metadata", "in": "body", "description": "Edited metadata of the app or deployment slot. See example.", "required": true, "schema": { "$ref": "#/definitions/StringDictionary" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the metadata of an app.", "description": "Gets the metadata of an app.", "operationId": "WebApps_ListMetadataSlot", "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 metadata for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StringDictionary" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/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", "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 publishing credentials for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/User" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": { "put": { "tags": [ "WebApps" ], "summary": "Updates the Push settings associated with web app.", "description": "Updates the Push settings associated with web app.", "operationId": "WebApps_UpdateSitePushSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "pushSettings", "in": "body", "description": "Push settings associated with web app.", "required": true, "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/PushSettings" } }, { "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": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/PushSettings" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": { "post": { "tags": [ "WebApps" ], "summary": "Gets the Push settings associated with web app.", "description": "Gets the Push settings associated with web app.", "operationId": "WebApps_ListSitePushSettingsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "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": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/PushSettings" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { "get": { "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", "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 return configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates the configuration of an app.", "description": "Updates the configuration of an app.", "operationId": "WebApps_CreateOrUpdateConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "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.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "patch": { "tags": [ "WebApps" ], "summary": "Updates the configuration of an app.", "description": "Updates the configuration of an app.", "operationId": "WebApps_UpdateConfigurationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "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.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": { "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", "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 return configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": { "get": { "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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 the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SiteConfigResource" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": { "post": { "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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 the deployment slot. If a slot is not specified, the API will return configuration for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "No Content" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": { "post": { "tags": [ "WebApps" ], "summary": "Gets the last lines of docker logs for the given site", "description": "Gets the last lines of docker logs for the given site", "operationId": "WebApps_GetWebSiteContainerLogsSlot", "produces": [ "application/octet-stream" ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "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": { "204": { "description": "No Content" }, "200": { "description": "OK", "schema": { "type": "file" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": { "post": { "tags": [ "WebApps" ], "summary": "Gets the ZIP archived docker log files for the given site", "description": "Gets the ZIP archived docker log files for the given site", "operationId": "WebApps_GetContainerLogsZipSlot", "produces": [ "application/zip" ], "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": { "204": { "description": "No Content" }, "200": { "description": "OK", "schema": { "type": "file" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": { "get": { "tags": [ "WebApps" ], "summary": "List continuous web jobs for an app, or a deployment slot.", "description": "List continuous web jobs for an app, or a deployment slot.", "operationId": "WebApps_ListContinuousWebJobsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContinuousWebJobCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_GetContinuousWebJobSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "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_DeleteContinuousWebJobSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted continuous web job." }, "204": { "description": "Continuous web job does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_StartContinuousWebJobSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "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" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "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}/deployments": { "get": { "tags": [ "WebApps" ], "summary": "List deployments for an app, or a deployment slot.", "description": "List deployments for an app, or a deployment slot.", "operationId": "WebApps_ListDeploymentsSlot", "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 returns deployments for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeploymentCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { "get": { "tags": [ "WebApps" ], "summary": "Get a deployment by its ID for an app, or a deployment slot.", "description": "Get a deployment by its ID for an app, or a deployment slot.", "operationId": "WebApps_GetDeploymentSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "Deployment ID.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Deployment" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Create a deployment for an app, or a deployment slot.", "description": "Create a deployment for an app, or a deployment slot.", "operationId": "WebApps_CreateDeploymentSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "ID of an existing deployment.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of 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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Deployment" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Delete a deployment by its ID for an app, or a deployment slot.", "description": "Delete a deployment by its ID for an app, or a deployment slot.", "operationId": "WebApps_DeleteDeploymentSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "Deployment ID.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of 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": "Successfully deleted deployment." }, "204": { "description": "Deployment does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": { "get": { "tags": [ "WebApps" ], "summary": "List deployment log for specific deployment for an app, or a deployment slot.", "description": "List deployment log for specific deployment for an app, or a deployment slot.", "operationId": "WebApps_ListDeploymentLogSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Deployment" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": { "post": { "tags": [ "WebApps" ], "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", "description": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", "operationId": "WebApps_DiscoverBackupSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", "required": true, "schema": { "$ref": "#/definitions/RestoreRequest" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RestoreRequest" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { "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", "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 binding for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/IdentifierCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": { "get": { "tags": [ "WebApps" ], "summary": "Get domain ownership identifier for web app.", "description": "Get domain ownership identifier for web app.", "operationId": "WebApps_GetDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "domainOwnershipIdentifierName", "in": "path", "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", "description": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.", "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a domain ownership identifier for a web app.", "description": "Deletes a domain ownership identifier for a web app.", "operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "domainOwnershipIdentifierName", "in": "path", "description": "Name of domain ownership identifier.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted domain ownership identifier." }, "204": { "description": "Domain ownership identifier does not exist." } } }, "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_UpdateDomainOwnershipIdentifierSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "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": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Identifier" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], "summary": "Get the status of the last MSDeploy operation.", "description": "Get the status of the last MSDeploy operation.", "operationId": "WebApps_GetMSDeployStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "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": "OK", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Invoke the MSDeploy web app extension.", "description": "Invoke the MSDeploy web app extension.", "operationId": "WebApps_CreateMSDeployOperationSlot", "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" }, { "name": "MSDeploy", "in": "body", "description": "Details of MSDeploy operation", "required": true, "schema": { "$ref": "#/definitions/MSDeploy" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "201": { "description": "Deployment is scheduled.", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "409": { "description": "Another deployment is in progress." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": { "get": { "tags": [ "WebApps" ], "summary": "Get the MSDeploy Log for the last MSDeploy operation.", "description": "Get the MSDeploy Log for the last MSDeploy operation.", "operationId": "WebApps_GetMSDeployLogSlot", "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": "MSDeploy log returned.", "schema": { "$ref": "#/definitions/MSDeployLog" } }, "404": { "description": "MSDeploy log not found." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": { "get": { "tags": [ "WebApps" ], "summary": "List the functions for a web site, or a deployment slot.", "description": "List the functions for a web site, or a deployment slot.", "operationId": "WebApps_ListInstanceFunctionsSlot", "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": "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}/slots/{slot}/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_GetFunctionsAdminTokenSlot", "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": "OK", "schema": { "type": "string" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_GetInstanceFunctionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "functionName", "in": "path", "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. 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": "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_CreateInstanceFunctionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "functionName", "in": "path", "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. 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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "201": { "description": "Function created.", "schema": { "$ref": "#/definitions/FunctionEnvelope" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "WebApps" ], "summary": "Delete a function for web site, or a deployment slot.", "description": "Delete a function for web site, or a deployment slot.", "operationId": "WebApps_DeleteInstanceFunctionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "functionName", "in": "path", "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "Function deleted." }, "404": { "description": "Function does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": { "post": { "tags": [ "WebApps" ], "summary": "Get function secrets for a function in a web site, or a deployment slot.", "description": "Get function secrets for a function in a web site, or a deployment slot.", "operationId": "WebApps_ListFunctionSecretsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "functionName", "in": "path", "description": "Function name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Function secrets returned.", "schema": { "$ref": "#/definitions/FunctionSecrets" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": { "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", "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 gets hostname bindings for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HostNameBindingCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": { "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", "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 the named binding for the production slot.", "required": true, "type": "string" }, { "name": "hostName", "in": "path", "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HostNameBinding" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a hostname binding for an app.", "description": "Creates a hostname binding for an app.", "operationId": "WebApps_CreateOrUpdateHostNameBindingSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "hostName", "in": "path", "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, { "name": "hostNameBinding", "in": "body", "description": "Binding details. This is the JSON representation of a HostNameBinding object.", "required": true, "schema": { "$ref": "#/definitions/HostNameBinding" } }, { "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HostNameBinding" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a hostname binding for an app.", "description": "Deletes a hostname binding for an app.", "operationId": "WebApps_DeleteHostNameBindingSlot", "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 binding for the production slot.", "required": true, "type": "string" }, { "name": "hostName", "in": "path", "description": "Hostname in the hostname binding.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": { "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "The name of the slot for the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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_CreateOrUpdateHybridConnectionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", "description": "The details of the hybrid connection.", "required": true, "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, { "name": "slot", "in": "path", "description": "The name of the slot for the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Removes a Hybrid Connection from this site.", "description": "Removes a Hybrid Connection from this site.", "operationId": "WebApps_DeleteHybridConnectionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "The name of the slot for the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted hybrid connection." }, "404": { "description": "Hybrid connection does not exist." } } }, "patch": { "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", "description": "The details of the hybrid connection.", "required": true, "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, { "name": "slot", "in": "path", "description": "The name of the slot for the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": { "post": { "tags": [ "WebApps" ], "summary": "Gets the send key name and value for a Hybrid Connection.", "description": "Gets the send key name and value for a Hybrid Connection.", "operationId": "WebApps_ListHybridConnectionKeysSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "namespaceName", "in": "path", "description": "The namespace for this hybrid connection.", "required": true, "type": "string" }, { "name": "relayName", "in": "path", "description": "The relay name for this hybrid connection.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "The name of the slot for the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnectionKey" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays": { "get": { "tags": [ "WebApps" ], "summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.", "description": "Retrieves all Service Bus Hybrid Connections used by this Web App.", "operationId": "WebApps_ListHybridConnectionsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "The name of the slot for the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": { "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", "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 hybrid connections for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a hybrid connection configuration by its name.", "description": "Gets a hybrid connection configuration by its name.", "operationId": "WebApps_GetRelayServiceConnectionSlot", "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.", "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.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "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", "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": "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" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "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": "Successfully 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", "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": "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" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RelayServiceConnectionEntity" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": { "get": { "tags": [ "WebApps" ], "summary": "Gets all scale-out instances of an app.", "description": "Gets all scale-out instances of an app.", "operationId": "WebApps_ListInstanceIdentifiersSlot", "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 gets the production slot instances.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WebAppInstanceCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy": { "get": { "tags": [ "WebApps" ], "summary": "Get the status of the last MSDeploy operation.", "description": "Get the status of the last MSDeploy operation.", "operationId": "WebApps_GetInstanceMsDeployStatusSlot", "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" }, { "name": "instanceId", "in": "path", "description": "ID of web app instance.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Invoke the MSDeploy web app extension.", "description": "Invoke the MSDeploy web app extension.", "operationId": "WebApps_CreateInstanceMSDeployOperationSlot", "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" }, { "name": "instanceId", "in": "path", "description": "ID of web app instance.", "required": true, "type": "string" }, { "name": "MSDeploy", "in": "body", "description": "Details of MSDeploy operation", "required": true, "schema": { "$ref": "#/definitions/MSDeploy" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "201": { "description": "Deployment is scheduled.", "schema": { "$ref": "#/definitions/MSDeployStatus" } }, "409": { "description": "Another deployment is in progress." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log": { "get": { "tags": [ "WebApps" ], "summary": "Get the MSDeploy Log for the last MSDeploy operation.", "description": "Get the MSDeploy Log for the last MSDeploy operation.", "operationId": "WebApps_GetInstanceMSDeployLogSlot", "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" }, { "name": "instanceId", "in": "path", "description": "ID of web app instance.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "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}/instances/{instanceId}/processes": { "get": { "tags": [ "WebApps" ], "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", "description": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListInstanceProcessesSlot", "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" }, { "name": "instanceId", "in": "path", "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Process terminated.", "schema": { "$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}/instances/{instanceId}/processes/{processId}": { "get": { "tags": [ "WebApps" ], "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", "description": "Get process information by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetInstanceProcessSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Process information returned.", "schema": { "$ref": "#/definitions/ProcessInfo" } }, "404": { "description": "Process with the specified ID is not running." } } }, "delete": { "tags": [ "WebApps" ], "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", "operationId": "WebApps_DeleteInstanceProcessSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "Process terminated." }, "404": { "description": "Process with the specified ID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump": { "get": { "tags": [ "WebApps" ], "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetInstanceProcessDumpSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } }, "404": { "description": "Process with the specified ID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules": { "get": { "tags": [ "WebApps" ], "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListInstanceProcessModulesSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Module information returned.", "schema": { "$ref": "#/definitions/ProcessModuleInfoCollection" } }, "404": { "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": { "get": { "tags": [ "WebApps" ], "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", "description": "Get process information by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetInstanceProcessModuleSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "baseAddress", "in": "path", "description": "Module base address.", "required": true, "type": "string" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Module information returned.", "schema": { "$ref": "#/definitions/ProcessModuleInfo" } }, "404": { "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads": { "get": { "tags": [ "WebApps" ], "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListInstanceProcessThreadsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Thread information returned.", "schema": { "$ref": "#/definitions/ProcessThreadInfoCollection" } }, "404": { "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads/{threadId}": { "get": { "tags": [ "WebApps" ], "summary": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", "description": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", "operationId": "WebApps_GetInstanceProcessThreadSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "threadId", "in": "path", "description": "TID.", "required": true, "type": "string" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Thread information returned.", "schema": { "$ref": "#/definitions/ProcessThreadInfo" } }, "404": { "description": "Either the thread with the specified TID was not found, or the process with the specified PID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": { "post": { "tags": [ "WebApps" ], "summary": "Shows whether an app can be cloned to another resource group or subscription.", "description": "Shows whether an app can be cloned to another resource group or subscription.", "operationId": "WebApps_IsCloneableSlot", "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. By default, this API returns information on the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/SiteCloneability" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus": { "post": { "tags": [ "WebApps" ], "summary": "This is to allow calling via powershell and ARM template.", "description": "This is to allow calling via powershell and ARM template.", "operationId": "WebApps_ListSyncFunctionTriggersSlot", "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": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FunctionSecrets" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_ListMetricDefinitionsSlot", "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 metric definitions of the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_ListMetricsSlot", "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 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]'.", "type": "string", "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ResourceMetricCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status": { "get": { "tags": [ "WebApps" ], "summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", "description": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled", "operationId": "WebApps_GetMigrateMySqlStatusSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MigrateMySqlStatus" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork": { "get": { "tags": [ "WebApps" ], "summary": "Gets a Swift Virtual Network connection.", "description": "Gets a Swift Virtual Network connection.", "operationId": "WebApps_GetSwiftVirtualNetworkConnectionSlot", "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 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/SwiftVirtualNetwork" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", "description": "Properties of the Virtual Network connection. See example.", "required": true, "schema": { "$ref": "#/definitions/SwiftVirtualNetwork" } }, { "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/SwiftVirtualNetwork" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", "description": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", "operationId": "WebApps_DeleteSwiftVirtualNetworkSlot", "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 connection for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted virtual network." }, "404": { "description": "Virtual network does not exist." } } }, "patch": { "tags": [ "WebApps" ], "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", "operationId": "WebApps_UpdateSwiftVirtualNetworkConnectionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", "description": "Properties of the Virtual Network connection. See example.", "required": true, "schema": { "$ref": "#/definitions/SwiftVirtualNetwork" } }, { "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/SwiftVirtualNetwork" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": { "get": { "tags": [ "WebApps" ], "summary": "Gets all network features used by the app (or deployment slot, if specified).", "description": "Gets all network features used by the app (or deployment slot, if specified).", "operationId": "WebApps_ListNetworkFeaturesSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "view", "in": "path", "description": "The type of view. This can either be \"summary\" or \"detailed\".", "required": true, "type": "string" }, { "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.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/NetworkFeatures" } }, "404": { "description": "The requested view does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "operationId": "WebApps_GetNetworkTraceOperationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "operationId", "in": "path", "description": "GUID of the operation.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "202": { "description": "Operation is in progress.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get the current status of a network trace operation for a site": { "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start": { "post": { "tags": [ "WebApps" ], "summary": "Start capturing network packets for the site (To be deprecated).", "description": "Start capturing network packets for the site (To be deprecated).", "operationId": "WebApps_StartWebSiteNetworkTraceSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "durationInSeconds", "in": "query", "description": "The duration to keep capturing in seconds.", "type": "integer", "format": "int32" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation": { "post": { "tags": [ "WebApps" ], "summary": "Start capturing network packets for the site.", "description": "Start capturing network packets for the site.", "operationId": "WebApps_StartWebSiteNetworkTraceOperationSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "durationInSeconds", "in": "query", "description": "The duration to keep capturing in seconds.", "type": "integer", "format": "int32" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "202": { "description": "Operation is in progress.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Start a new network trace operation for a site": { "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop": { "post": { "tags": [ "WebApps" ], "summary": "Stop ongoing capturing network packets for the site.", "description": "Stop ongoing capturing network packets for the site.", "operationId": "WebApps_StopWebSiteNetworkTraceSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "The name of the slot for this web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Stopped." }, "204": { "description": "Stopped." } }, "x-ms-examples": { "Stop a currently running network trace operation for a site": { "$ref": "./examples/StopWebSiteNetworkTrace.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "operationId": "WebApps_GetNetworkTracesSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "operationId", "in": "path", "description": "GUID of the operation.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get NetworkTraces for a site": { "$ref": "./examples/GetWebSiteNetworkTraces.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "operationId": "WebApps_GetNetworkTraceOperationSlotV2", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "operationId", "in": "path", "description": "GUID of the operation.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "202": { "description": "Operation is in progress.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get the current status of a network trace operation for a site": { "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", "operationId": "WebApps_GetNetworkTracesSlotV2", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "operationId", "in": "path", "description": "GUID of the operation.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get NetworkTraces for a site": { "$ref": "./examples/GetWebSiteNetworkTraces.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { "post": { "tags": [ "WebApps" ], "summary": "Generates a new publishing password for an app (or deployment slot, if specified).", "description": "Generates a new publishing password for an app (or deployment slot, if specified).", "operationId": "WebApps_GenerateNewSitePublishingPasswordSlot", "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 generate a new publishing password for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully generate new password." }, "204": { "description": "Successfully generate new password." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters": { "get": { "tags": [ "WebApps" ], "summary": "Gets perfmon counters for web app.", "description": "Gets perfmon counters for web app.", "operationId": "WebApps_ListPerfMonCountersSlot", "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" }, { "name": "$filter", "in": "query", "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.", "type": "string", "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PerfMonCounterCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging": { "get": { "tags": [ "WebApps" ], "summary": "Gets web app's event logs.", "description": "Gets web app's event logs.", "operationId": "WebApps_GetSitePhpErrorLogFlagSlot", "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": "OK", "schema": { "$ref": "#/definitions/SitePhpErrorLogFlag" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": { "get": { "tags": [ "WebApps" ], "summary": "Gets the premier add-ons of an app.", "description": "Gets the premier add-ons of an app.", "operationId": "WebApps_ListPremierAddOnsSlot", "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 premier add-ons for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PremierAddOn" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": { "get": { "tags": [ "WebApps" ], "summary": "Gets a named add-on of an app.", "description": "Gets a named add-on of an app.", "operationId": "WebApps_GetPremierAddOnSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "premierAddOnName", "in": "path", "description": "Add-on name.", "required": true, "type": "string" }, { "name": "slot", "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.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PremierAddOn" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates a named add-on of an app.", "description": "Updates a named add-on of an app.", "operationId": "WebApps_AddPremierAddOnSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "premierAddOnName", "in": "path", "description": "Add-on name.", "required": true, "type": "string" }, { "name": "premierAddOn", "in": "body", "description": "A JSON representation of the edited premier add-on.", "required": true, "schema": { "$ref": "#/definitions/PremierAddOn" } }, { "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PremierAddOn" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Delete a premier add-on from an app.", "description": "Delete a premier add-on from an app.", "operationId": "WebApps_DeletePremierAddOnSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "premierAddOnName", "in": "path", "description": "Add-on name.", "required": true, "type": "string" }, { "name": "slot", "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.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted premier add-on." } } }, "patch": { "tags": [ "WebApps" ], "summary": "Updates a named add-on of an app.", "description": "Updates a named add-on of an app.", "operationId": "WebApps_UpdatePremierAddOnSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "premierAddOnName", "in": "path", "description": "Add-on name.", "required": true, "type": "string" }, { "name": "premierAddOn", "in": "body", "description": "A JSON representation of the edited premier add-on.", "required": true, "schema": { "$ref": "#/definitions/PremierAddOnPatchResource" } }, { "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PremierAddOn" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks": { "get": { "tags": [ "WebApps" ], "summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", "description": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.", "operationId": "WebApps_GetPrivateAccessSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "The name of the slot for the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivateAccess" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", "description": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.", "operationId": "WebApps_PutPrivateAccessVnetSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "access", "in": "body", "description": "The information for the private access", "required": true, "schema": { "$ref": "#/definitions/PrivateAccess" } }, { "name": "slot", "in": "path", "description": "The name of the slot for the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivateAccess" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes": { "get": { "tags": [ "WebApps" ], "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", "description": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListProcessesSlot", "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": "Process terminated.", "schema": { "$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}/processes/{processId}": { "get": { "tags": [ "WebApps" ], "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", "description": "Get process information by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetProcessSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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": "Process information returned.", "schema": { "$ref": "#/definitions/ProcessInfo" } }, "404": { "description": "Process with the specified ID is not running." } } }, "delete": { "tags": [ "WebApps" ], "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", "description": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.", "operationId": "WebApps_DeleteProcessSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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": { "204": { "description": "Process terminated." }, "404": { "description": "Process with the specified ID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump": { "get": { "tags": [ "WebApps" ], "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", "description": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetProcessDumpSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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": { "type": "file" } }, "404": { "description": "Process with the specified ID is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules": { "get": { "tags": [ "WebApps" ], "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.", "description": "List module information for a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListProcessModulesSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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": "Module information returned.", "schema": { "$ref": "#/definitions/ProcessModuleInfoCollection" } }, "404": { "description": "Process with the specified ID is not running." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}": { "get": { "tags": [ "WebApps" ], "summary": "Get process information by its ID for a specific scaled-out instance in a web site.", "description": "Get process information by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_GetProcessModuleSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "baseAddress", "in": "path", "description": "Module base address.", "required": true, "type": "string" }, { "name": "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": "Module information returned.", "schema": { "$ref": "#/definitions/ProcessModuleInfo" } }, "404": { "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads": { "get": { "tags": [ "WebApps" ], "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", "description": "List the threads in a process by its ID for a specific scaled-out instance in a web site.", "operationId": "WebApps_ListProcessThreadsSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "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": "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}/processes/{processId}/threads/{threadId}": { "get": { "tags": [ "WebApps" ], "summary": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", "description": "Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.", "operationId": "WebApps_GetProcessThreadSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "processId", "in": "path", "description": "PID.", "required": true, "type": "string" }, { "name": "threadId", "in": "path", "description": "TID.", "required": true, "type": "string" }, { "name": "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": "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}/publicCertificates": { "get": { "tags": [ "WebApps" ], "summary": "Get public certificates for an app or a deployment slot.", "description": "Get public certificates for an app or a deployment slot.", "operationId": "WebApps_ListPublicCertificatesSlot", "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 gets hostname bindings for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicCertificateCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}": { "get": { "tags": [ "WebApps" ], "summary": "Get the named public certificate for an app (or deployment slot, if specified).", "description": "Get the named public certificate for an app (or deployment slot, if specified).", "operationId": "WebApps_GetPublicCertificateSlot", "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 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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicCertificate" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Creates a hostname binding for an app.", "description": "Creates a hostname binding for an app.", "operationId": "WebApps_CreateOrUpdatePublicCertificateSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "publicCertificateName", "in": "path", "description": "Public certificate name.", "required": true, "type": "string" }, { "name": "publicCertificate", "in": "body", "description": "Public certificate details. This is the JSON representation of a PublicCertificate object.", "required": true, "schema": { "$ref": "#/definitions/PublicCertificate" } }, { "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicCertificate" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "delete": { "tags": [ "WebApps" ], "summary": "Deletes a hostname binding for an app.", "description": "Deletes a hostname binding for an app.", "operationId": "WebApps_DeletePublicCertificateSlot", "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 binding for the production slot.", "required": true, "type": "string" }, { "name": "publicCertificateName", "in": "path", "description": "Public certificate name.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": { "post": { "tags": [ "WebApps" ], "summary": "Gets the publishing profile for an app (or deployment slot, if specified).", "description": "Gets the publishing profile for an app (or deployment slot, if specified).", "operationId": "WebApps_ListPublishingProfileXmlWithSecretsSlot", "produces": [ "application/xml" ], "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "publishingProfileOptions", "in": "body", "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.", "required": true, "schema": { "$ref": "#/definitions/CsmPublishingProfileOptions" } }, { "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" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_ResetSlotConfigurationSlot", "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 resets configuration settings for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": { "post": { "tags": [ "WebApps" ], "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" }, { "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 restart the production slot.", "required": true, "type": "string" }, { "name": "softRestart", "in": "query", "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.", "type": "boolean" }, { "name": "synchronous", "in": "query", "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).", "type": "boolean" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully restarted app." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob": { "post": { "tags": [ "WebApps" ], "summary": "Restores an app from a backup blob in Azure Storage.", "description": "Restores an app from a backup blob in Azure Storage.", "operationId": "WebApps_RestoreFromBackupBlobSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the app.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Information on restore request .", "required": true, "schema": { "$ref": "#/definitions/RestoreRequest" } }, { "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": { "202": { "description": "Restore operation started." }, "200": { "description": "Restore operation started." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp": { "post": { "tags": [ "WebApps" ], "summary": "Restores a deleted web app to this web app.", "description": "Restores a deleted web app to this web app.", "operationId": "WebApps_RestoreFromDeletedAppSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "restoreRequest", "in": "body", "description": "Deleted web app restore information.", "required": true, "schema": { "$ref": "#/definitions/DeletedAppRestoreRequest" } }, { "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": { "202": { "description": "Restore operation started." }, "200": { "description": "Restore operation started." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot": { "post": { "tags": [ "WebApps" ], "summary": "Restores a web app from a snapshot.", "description": "Restores a web app from a snapshot.", "operationId": "WebApps_RestoreSnapshotSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of web app.", "required": true, "type": "string" }, { "name": "restoreRequest", "in": "body", "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.", "required": true, "schema": { "$ref": "#/definitions/SnapshotRestoreRequest" } }, { "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": { "202": { "description": "Restore operation started." }, "200": { "description": "Restore operation started." } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions": { "get": { "tags": [ "WebApps" ], "summary": "Get list of siteextensions for a web site, or a deployment slot.", "description": "Get list of siteextensions for a web site, or a deployment slot.", "operationId": "WebApps_ListSiteExtensionsSlot", "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": "SiteExtension information returned.", "schema": { "$ref": "#/definitions/SiteExtensionInfoCollection" } }, "404": { "description": "SiteExtension not found." } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}": { "get": { "tags": [ "WebApps" ], "summary": "Get site extension information by its ID for a web site, or a deployment slot.", "description": "Get site extension information by its ID for a web site, or a deployment slot.", "operationId": "WebApps_GetSiteExtensionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "siteExtensionId", "in": "path", "description": "Site extension name.", "required": true, "type": "string" }, { "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": "SiteExtension information returned.", "schema": { "$ref": "#/definitions/SiteExtensionInfo" } }, "404": { "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } }, "put": { "tags": [ "WebApps" ], "summary": "Install site extension on a web site, or a deployment slot.", "description": "Install site extension on a web site, or a deployment slot.", "operationId": "WebApps_InstallSiteExtensionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "siteExtensionId", "in": "path", "description": "Site extension name.", "required": true, "type": "string" }, { "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": { "201": { "description": "Site Extension created.", "schema": { "$ref": "#/definitions/SiteExtensionInfo" } }, "200": { "description": "Site Extension created.", "schema": { "$ref": "#/definitions/SiteExtensionInfo" } }, "429": { "description": "Site Extension is being installed on another request: Rejecting current request." } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "WebApps" ], "summary": "Remove a site extension from a web site, or a deployment slot.", "description": "Remove a site extension from a web site, or a deployment slot.", "operationId": "WebApps_DeleteSiteExtensionSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "siteExtensionId", "in": "path", "description": "Site extension name.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "SiteExtension terminated." }, "404": { "description": "SiteExtension with an ID of {siteExtensionId} is not running." } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/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_ListSlotDifferencesSlot", "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" } }, { "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", "schema": { "$ref": "#/definitions/SlotDifferenceCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": { "post": { "tags": [ "WebApps" ], "summary": "Swaps two deployment slots of an app.", "description": "Swaps two deployment slots of an app.", "operationId": "WebApps_SwapSlotSlot", "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" } }, { "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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr": { "get": { "tags": [ "WebApps" ], "summary": "Returns all Snapshots to the user from DRSecondary endpoint.", "description": "Returns all Snapshots to the user from DRSecondary endpoint.", "operationId": "WebApps_ListSnapshotsFromDRSecondarySlot", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "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": "Successfully retrieved source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "201": { "description": "Create or update source control for web app still in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "202": { "description": "Create or update source control for web app still in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates the source control configuration of an app.", "description": "Updates the source control configuration of an app.", "operationId": "WebApps_CreateOrUpdateSourceControlSlot", "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": "Successfully 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" } }, "202": { "description": "Create or update source control for web app in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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": "Successfully deleted source control for web app." }, "202": { "description": "Source control delete operation in progress." }, "404": { "description": "Source control does not exist." } } }, "patch": { "tags": [ "WebApps" ], "summary": "Updates the source control configuration of an app.", "description": "Updates the source control configuration of an app.", "operationId": "WebApps_UpdateSourceControlSlot", "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": "Successfully 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" } }, "202": { "description": "Create or update source control for web app in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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}/startNetworkTrace": { "post": { "tags": [ "WebApps" ], "summary": "Start capturing network packets for the site.", "description": "Start capturing network packets for the site.", "operationId": "WebApps_StartNetworkTraceSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "durationInSeconds", "in": "query", "description": "The duration to keep capturing in seconds.", "type": "integer", "format": "int32" }, { "name": "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" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "202": { "description": "Operation is in progress.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Start a new network trace operation for a site": { "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/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}/stopNetworkTrace": { "post": { "tags": [ "WebApps" ], "summary": "Stop ongoing capturing network packets for the site.", "description": "Stop ongoing capturing network packets for the site.", "operationId": "WebApps_StopNetworkTraceSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "The name of the slot for this web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Stopped." }, "204": { "description": "Stopped." } }, "x-ms-examples": { "Stop a currently running network trace operation for a site": { "$ref": "./examples/StopWebSiteNetworkTrace.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/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 source control." } } } }, "/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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "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": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully 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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "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" }, { "$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": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "slot", "in": "path", "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Run a triggered 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", "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]'.", "type": "string", "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/CsmUsageQuotaCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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", "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": "../2018-02-01/CommonDefinitions.json#/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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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": "Successfully 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", "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": "../2018-02-01/CommonDefinitions.json#/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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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": "../2018-02-01/CommonDefinitions.json#/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", "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": "../2018-02-01/CommonDefinitions.json#/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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetGateway" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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", "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": "../2018-02-01/CommonDefinitions.json#/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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetGateway" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr": { "get": { "tags": [ "WebApps" ], "summary": "Returns all Snapshots to the user from DRSecondary endpoint.", "description": "Returns all Snapshots to the user from DRSecondary endpoint.", "operationId": "WebApps_ListSnapshotsFromDRSecondary", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "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 retrieved source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "201": { "description": "Create or update source control for web app still in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "202": { "description": "Create or update source control for web app still in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "put": { "tags": [ "WebApps" ], "summary": "Updates the source control configuration of an app.", "description": "Updates the source control configuration of an app.", "operationId": "WebApps_CreateOrUpdateSourceControl", "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": "Successfully 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" } }, "202": { "description": "Create or update source control for web app in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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": "Successfully deleted source control for web app." }, "202": { "description": "Source control delete operation in progress." }, "404": { "description": "Source control does not exist." } } }, "patch": { "tags": [ "WebApps" ], "summary": "Updates the source control configuration of an app.", "description": "Updates the source control configuration of an app.", "operationId": "WebApps_UpdateSourceControl", "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": "Successfully 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" } }, "202": { "description": "Create or update source control for web app in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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}/startNetworkTrace": { "post": { "tags": [ "WebApps" ], "summary": "Start capturing network packets for the site.", "description": "Start capturing network packets for the site.", "operationId": "WebApps_StartNetworkTrace", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "name": "durationInSeconds", "in": "query", "description": "The duration to keep capturing in seconds.", "type": "integer", "format": "int32" }, { "name": "maxFrameLength", "in": "query", "description": "The maximum frame length in bytes (Optional).", "type": "integer", "format": "int32" }, { "name": "sasUrl", "in": "query", "description": "The Blob URL to store capture file.", "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "202": { "description": "Operation is in progress.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NetworkTrace" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Start a new network trace operation for a site": { "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/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}/stopNetworkTrace": { "post": { "tags": [ "WebApps" ], "summary": "Stop ongoing capturing network packets for the site.", "description": "Stop ongoing capturing network packets for the site.", "operationId": "WebApps_StopNetworkTrace", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the web app.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Stopped." }, "204": { "description": "Stopped." } }, "x-ms-examples": { "Stop a currently running network trace operation for a site": { "$ref": "./examples/StopWebSiteNetworkTrace.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/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 source control." } } } }, "/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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "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": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully 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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "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", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Site name.", "required": true, "type": "string" }, { "name": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "History ID.", "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": "webJobName", "in": "path", "description": "Name of Web Job.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Run a triggered 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", "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]'.", "type": "string", "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/CsmUsageQuotaCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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", "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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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": "Successfully 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", "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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/VnetInfo" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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": "../2018-02-01/CommonDefinitions.json#/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", "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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetGateway" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/VnetGateway" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } }, "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", "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": "../2018-02-01/CommonDefinitions.json#/definitions/VnetGateway" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/VnetGateway" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } }, "/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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "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", "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" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/DefaultErrorResponse" } } } } } }, "definitions": { "ApplicationLogsConfig": { "description": "Application logs configuration.", "type": "object", "properties": { "fileSystem": { "$ref": "#/definitions/FileSystemApplicationLogsConfig", "description": "Application logs to file system configuration." }, "azureTableStorage": { "$ref": "#/definitions/AzureTableStorageApplicationLogsConfig", "description": "Application logs to azure table storage configuration." }, "azureBlobStorage": { "$ref": "#/definitions/AzureBlobStorageApplicationLogsConfig", "description": "Application logs to blob storage configuration." } } }, "AzureBlobStorageApplicationLogsConfig": { "description": "Application logs azure blob storage configuration.", "type": "object", "properties": { "level": { "description": "Log level.", "enum": [ "Off", "Verbose", "Information", "Warning", "Error" ], "type": "string", "x-ms-enum": { "name": "LogLevel", "modelAsString": false } }, "sasUrl": { "description": "SAS url to a azure blob container with read/write/list/delete permissions.", "type": "string" }, "retentionInDays": { "format": "int32", "description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention.", "type": "integer" } } }, "AzureBlobStorageHttpLogsConfig": { "description": "Http logs to azure blob storage configuration.", "type": "object", "properties": { "sasUrl": { "description": "SAS url to a azure blob container with read/write/list/delete permissions.", "type": "string" }, "retentionInDays": { "format": "int32", "description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention.", "type": "integer" }, "enabled": { "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.", "type": "boolean" } } }, "AzureStoragePropertyDictionaryResource": { "description": "AzureStorageInfo dictionary resource.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "Azure storage accounts.", "type": "object", "additionalProperties": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/AzureStorageInfoValue" }, "x-ms-client-flatten": true } } }, "AzureTableStorageApplicationLogsConfig": { "description": "Application logs to Azure table storage configuration.", "required": [ "sasUrl" ], "type": "object", "properties": { "level": { "description": "Log level.", "enum": [ "Off", "Verbose", "Information", "Warning", "Error" ], "type": "string", "x-ms-enum": { "name": "LogLevel", "modelAsString": false } }, "sasUrl": { "description": "SAS URL to an Azure table with add/query/delete permissions.", "type": "string" } } }, "BackupItem": { "description": "Backup description.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "BackupItem resource specific properties", "properties": { "id": { "format": "int32", "description": "Id of the backup.", "type": "integer", "readOnly": true, "x-ms-client-name": "BackupId" }, "storageAccountUrl": { "description": "SAS URL for the storage account container which contains this backup.", "type": "string", "readOnly": true }, "blobName": { "description": "Name of the blob which contains data for this backup.", "type": "string", "readOnly": true }, "name": { "description": "Name of this backup.", "type": "string", "readOnly": true }, "status": { "description": "Backup status.", "enum": [ "InProgress", "Failed", "Succeeded", "TimedOut", "Created", "Skipped", "PartiallySucceeded", "DeleteInProgress", "DeleteFailed", "Deleted" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "BackupItemStatus", "modelAsString": false } }, "sizeInBytes": { "format": "int64", "description": "Size of the backup in bytes.", "type": "integer", "readOnly": true }, "created": { "format": "date-time", "description": "Timestamp of the backup creation.", "type": "string", "readOnly": true }, "log": { "description": "Details regarding this backup. Might contain an error message.", "type": "string", "readOnly": true }, "databases": { "description": "List of databases included in the backup.", "type": "array", "items": { "$ref": "#/definitions/DatabaseBackupSetting" }, "readOnly": true }, "scheduled": { "description": "True if this backup has been created due to a schedule being triggered.", "type": "boolean", "readOnly": true }, "lastRestoreTimeStamp": { "format": "date-time", "description": "Timestamp of a last restore operation which used this backup.", "type": "string", "readOnly": true }, "finishedTimeStamp": { "format": "date-time", "description": "Timestamp when this backup finished.", "type": "string", "readOnly": true }, "correlationId": { "description": "Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.", "type": "string", "readOnly": true }, "websiteSizeInBytes": { "format": "int64", "description": "Size of the original web app which has been backed up.", "type": "integer", "readOnly": true } }, "x-ms-client-flatten": true } } }, "BackupItemCollection": { "description": "Collection of backup items.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/BackupItem" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "BackupRequest": { "description": "Description of a backup which will be performed.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "BackupRequest resource specific properties", "required": [ "storageAccountUrl" ], "properties": { "backupName": { "description": "Name of the backup.", "type": "string" }, "enabled": { "description": "True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.", "type": "boolean" }, "storageAccountUrl": { "description": "SAS URL to the container.", "type": "string" }, "backupSchedule": { "$ref": "#/definitions/BackupSchedule", "description": "Schedule for the backup if it is executed periodically." }, "databases": { "description": "Databases included in the backup.", "type": "array", "items": { "$ref": "#/definitions/DatabaseBackupSetting" } } }, "x-ms-client-flatten": true } } }, "BackupSchedule": { "description": "Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.", "required": [ "frequencyInterval", "frequencyUnit", "keepAtLeastOneBackup", "retentionPeriodInDays" ], "type": "object", "properties": { "frequencyInterval": { "format": "int32", "description": "How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)", "default": 7, "type": "integer" }, "frequencyUnit": { "description": "The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)", "default": "Day", "enum": [ "Day", "Hour" ], "type": "string", "x-ms-enum": { "name": "FrequencyUnit", "modelAsString": false } }, "keepAtLeastOneBackup": { "description": "True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.", "default": true, "type": "boolean" }, "retentionPeriodInDays": { "format": "int32", "description": "After how many days backups should be deleted.", "default": 30, "type": "integer" }, "startTime": { "format": "date-time", "description": "When the schedule should start working.", "type": "string" }, "lastExecutionTime": { "format": "date-time", "description": "Last time when this schedule was triggered.", "type": "string", "readOnly": true } } }, "ConnStringValueTypePair": { "description": "Database connection string value to type pair.", "required": [ "value", "type" ], "type": "object", "properties": { "value": { "description": "Value of pair.", "type": "string" }, "type": { "description": "Type of database.", "enum": [ "MySql", "SQLServer", "SQLAzure", "Custom", "NotificationHub", "ServiceBus", "EventHub", "ApiHub", "DocDb", "RedisCache", "PostgreSQL" ], "type": "string", "x-ms-enum": { "name": "ConnectionStringType", "modelAsString": false } } } }, "ConnectionStringDictionary": { "description": "String dictionary resource.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "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": "../2018-02-01/CommonDefinitions.json#/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 } }, "detailed_status": { "description": "Detailed status.", "type": "string" }, "log_url": { "description": "Log URL.", "type": "string" }, "run_command": { "description": "Run command.", "type": "string" }, "url": { "description": "Job URL.", "type": "string" }, "extra_info_url": { "description": "Extra Info URL.", "type": "string" }, "web_job_type": { "description": "Job type.", "enum": [ "Continuous", "Triggered" ], "type": "string", "x-ms-enum": { "name": "WebJobType", "modelAsString": false } }, "error": { "description": "Error information.", "type": "string" }, "using_sdk": { "description": "Using SDK?", "type": "boolean" }, "settings": { "description": "Job settings.", "type": "object", "additionalProperties": { "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", "readOnly": true } } }, "CsmPublishingProfileOptions": { "description": "Publishing options for requested profile.", "type": "object", "properties": { "format": { "description": "Name of the format. Valid values are: \nFileZilla3\nWebDeploy -- default\nFtp", "enum": [ "FileZilla3", "WebDeploy", "Ftp" ], "type": "string", "x-ms-enum": { "name": "PublishingProfileFormat", "modelAsString": true } }, "includeDisasterRecoveryEndpoints": { "description": "Include the DisasterRecover endpoint if true", "type": "boolean" } } }, "CsmSlotEntity": { "description": "Deployment slot parameters.", "required": [ "targetSlot", "preserveVnet" ], "type": "object", "properties": { "targetSlot": { "description": "Destination deployment slot during swap operation.", "type": "string" }, "preserveVnet": { "description": "true to preserve Virtual Network to the slot during swap; otherwise, false.", "type": "boolean" } } }, "CustomHostnameAnalysisResult": { "description": "Custom domain analysis.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "CustomHostnameAnalysisResult resource specific properties", "properties": { "isHostnameAlreadyVerified": { "description": "true if hostname is already verified; otherwise, false.", "type": "boolean", "readOnly": true }, "customDomainVerificationTest": { "description": "DNS verification test result.", "enum": [ "Passed", "Failed", "Skipped" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "DnsVerificationTestResult", "modelAsString": false } }, "customDomainVerificationFailureInfo": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ErrorEntity", "description": "Raw failure information if DNS verification fails.", "readOnly": true }, "hasConflictOnScaleUnit": { "description": "true if there is a conflict on a scale unit; otherwise, false.", "type": "boolean", "readOnly": true }, "hasConflictAcrossSubscription": { "description": "true if there is a conflict across subscriptions; otherwise, false.", "type": "boolean", "readOnly": true }, "conflictingAppResourceId": { "description": "Name of the conflicting app on scale unit if it's within the same subscription.", "type": "string", "readOnly": true }, "cNameRecords": { "description": "CName records controller can see for this hostname.", "type": "array", "items": { "type": "string" } }, "txtRecords": { "description": "TXT records controller can see for this hostname.", "type": "array", "items": { "type": "string" } }, "aRecords": { "description": "A records controller can see for this hostname.", "type": "array", "items": { "type": "string" } }, "alternateCNameRecords": { "description": "Alternate CName records controller can see for this hostname.", "type": "array", "items": { "type": "string" } }, "alternateTxtRecords": { "description": "Alternate TXT records controller can see for this hostname.", "type": "array", "items": { "type": "string" } } }, "x-ms-client-flatten": true } } }, "DatabaseBackupSetting": { "description": "Database backup settings.", "required": [ "databaseType" ], "type": "object", "properties": { "databaseType": { "description": "Database type (e.g. SqlAzure / MySql).", "enum": [ "SqlAzure", "MySql", "LocalMySql", "PostgreSql" ], "type": "string", "x-ms-enum": { "name": "DatabaseType", "modelAsString": true } }, "name": { "type": "string" }, "connectionStringName": { "description": "Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options.", "type": "string" }, "connectionString": { "description": "Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.", "type": "string" } } }, "DeletedAppRestoreRequest": { "description": "Details about restoring a deleted app.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "DeletedAppRestoreRequest resource specific properties", "properties": { "deletedSiteId": { "description": "ARM resource ID of the deleted app. Example:\n/subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}", "type": "string" }, "recoverConfiguration": { "description": "If true, deleted site configuration, in addition to content, will be restored.", "type": "boolean" }, "snapshotTime": { "description": "Point in time to restore the deleted app from, formatted as a DateTime string. \nIf unspecified, default value is the time that the app was deleted.", "type": "string" }, "useDRSecondary": { "description": "If true, the snapshot is retrieved from DRSecondary endpoint.", "type": "boolean" } }, "x-ms-client-flatten": true } } }, "Deployment": { "description": "User credentials used for publishing activity.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "Deployment resource specific properties", "properties": { "status": { "format": "int32", "description": "Deployment status.", "type": "integer" }, "message": { "description": "Details about deployment status.", "type": "string" }, "author": { "description": "Who authored the deployment.", "type": "string" }, "deployer": { "description": "Who performed the deployment.", "type": "string" }, "author_email": { "description": "Author email.", "type": "string" }, "start_time": { "format": "date-time", "description": "Start time.", "type": "string" }, "end_time": { "format": "date-time", "description": "End time.", "type": "string" }, "active": { "description": "True if deployment is currently active, false if completed and null if not started.", "type": "boolean" }, "details": { "description": "Details on deployment.", "type": "string" } }, "x-ms-client-flatten": true } } }, "DeploymentCollection": { "description": "Collection of app deployments.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/Deployment" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "EnabledConfig": { "description": "Enabled configuration.", "type": "object", "properties": { "enabled": { "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.", "type": "boolean" } } }, "FileSystemApplicationLogsConfig": { "description": "Application logs to file system configuration.", "type": "object", "properties": { "level": { "description": "Log level.", "default": "Off", "enum": [ "Off", "Verbose", "Information", "Warning", "Error" ], "type": "string", "x-ms-enum": { "name": "LogLevel", "modelAsString": false } } } }, "FileSystemHttpLogsConfig": { "description": "Http logs to file system configuration.", "type": "object", "properties": { "retentionInMb": { "format": "int32", "description": "Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100.", "maximum": 100, "minimum": 25, "type": "integer" }, "retentionInDays": { "format": "int32", "description": "Retention in days.\nRemove files older than X days.\n0 or lower means no retention.", "type": "integer" }, "enabled": { "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.", "type": "boolean" } } }, "FunctionEnvelope": { "description": "Web Job Information.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "FunctionEnvelope resource specific properties", "properties": { "function_app_id": { "description": "Function App ID.", "type": "string" }, "script_root_path_href": { "description": "Script root path URI.", "type": "string" }, "script_href": { "description": "Script URI.", "type": "string" }, "config_href": { "description": "Config URI.", "type": "string" }, "secrets_file_href": { "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" } }, "test_data": { "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", "readOnly": true } } }, "FunctionSecrets": { "description": "Function secrets.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "FunctionSecrets resource specific properties", "properties": { "key": { "description": "Secret key.", "type": "string" }, "trigger_url": { "description": "Trigger URL.", "type": "string" } }, "x-ms-client-flatten": true } } }, "HostNameBinding": { "description": "A hostname binding object.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "HostNameBinding resource specific properties", "properties": { "siteName": { "description": "App Service app name.", "type": "string", "x-ms-mutability": [ "create", "read" ] }, "domainId": { "description": "Fully qualified ARM domain resource URI.", "type": "string", "x-ms-mutability": [ "create", "read" ] }, "azureResourceName": { "description": "Azure resource name.", "type": "string", "x-ms-mutability": [ "create", "read" ] }, "azureResourceType": { "description": "Azure resource type.", "enum": [ "Website", "TrafficManager" ], "type": "string", "x-ms-enum": { "name": "AzureResourceType", "modelAsString": false }, "x-ms-mutability": [ "create", "read" ] }, "customHostNameDnsRecordType": { "description": "Custom DNS record type.", "enum": [ "CName", "A" ], "type": "string", "x-ms-enum": { "name": "CustomHostNameDnsRecordType", "modelAsString": false }, "x-ms-mutability": [ "create", "read" ] }, "hostNameType": { "description": "Hostname type.", "enum": [ "Verified", "Managed" ], "type": "string", "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", "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." } } }, "MSDeploy": { "description": "MSDeploy ARM PUT information", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "$ref": "#/definitions/MSDeployCore", "description": "Core resource properties", "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" }, "connectionString": { "description": "SQL Connection String", "type": "string" }, "dbType": { "description": "Database Type", "type": "string" }, "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.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default.", "type": "boolean" }, "appOffline": { "description": "Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default.", "type": "boolean" } } }, "MSDeployLog": { "description": "MSDeploy log", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/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 } }, "message": { "description": "Log entry message", "type": "string", "readOnly": true } } }, "MSDeployStatus": { "description": "MSDeploy ARM response", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "MSDeployStatus resource specific properties", "properties": { "deployer": { "description": "Username of deployer", "type": "string", "readOnly": true }, "provisioningState": { "description": "Provisioning state", "enum": [ "accepted", "running", "succeeded", "failed", "canceled" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "MSDeployProvisioningState", "modelAsString": false } }, "startTime": { "format": "date-time", "description": "Start time of deploy operation", "type": "string", "readOnly": true }, "endTime": { "format": "date-time", "description": "End time of deploy operation", "type": "string", "readOnly": true }, "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": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "MigrateMySqlRequest resource specific properties", "required": [ "connectionString", "migrationType" ], "properties": { "connectionString": { "description": "Connection string to the remote MySQL database.", "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 } } }, "MigrateMySqlStatus": { "description": "MySQL migration status.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "MigrateMySqlStatus 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 } }, "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 } } }, "NetworkFeatures": { "description": "Full view of network features for an app (presently VNET integration and Hybrid Connections).", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "NetworkFeatures resource specific properties", "properties": { "virtualNetworkName": { "description": "The Virtual Network name.", "type": "string", "readOnly": true }, "virtualNetworkConnection": { "$ref": "../2018-02-01/CommonDefinitions.json#/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": "../2018-02-01/CommonDefinitions.json#/definitions/HybridConnection" }, "readOnly": true } }, "x-ms-client-flatten": true } } }, "NetworkTrace": { "description": "Network trace", "type": "object", "properties": { "path": { "description": "Local file path for the captured network trace file.", "type": "string" }, "status": { "description": "Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed).", "type": "string" }, "message": { "description": "Detailed message of a network trace operation, e.g. error message in case of failure.", "type": "string" } } }, "PerfMonCounterCollection": { "description": "Collection of performance monitor counters.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/PerfMonResponse" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "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" } } }, "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.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Resource" } ], "properties": { "properties": { "description": "PremierAddOn resource specific properties", "properties": { "sku": { "description": "Premier add on SKU.", "type": "string" }, "product": { "description": "Premier add on Product.", "type": "string" }, "vendor": { "description": "Premier add on Vendor.", "type": "string" }, "marketplacePublisher": { "description": "Premier add on Marketplace publisher.", "type": "string" }, "marketplaceOffer": { "description": "Premier add on Marketplace offer.", "type": "string" } }, "x-ms-client-flatten": true } } }, "PremierAddOnPatchResource": { "description": "ARM resource for a PremierAddOn.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "PremierAddOnPatchResource resource specific properties", "properties": { "sku": { "description": "Premier add on SKU.", "type": "string" }, "product": { "description": "Premier add on Product.", "type": "string" }, "vendor": { "description": "Premier add on Vendor.", "type": "string" }, "marketplacePublisher": { "description": "Premier add on Marketplace publisher.", "type": "string" }, "marketplaceOffer": { "description": "Premier add on Marketplace offer.", "type": "string" } }, "x-ms-client-flatten": true } } }, "PrivateAccess": { "description": "Description of the parameters of Private Access for a Web Site.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "PrivateAccess resource specific properties", "properties": { "enabled": { "description": "Whether private access is enabled or not.", "type": "boolean" }, "virtualNetworks": { "description": "The Virtual Networks (and subnets) allowed to access the site privately.", "type": "array", "items": { "$ref": "#/definitions/PrivateAccessVirtualNetwork" } } }, "x-ms-client-flatten": true } } }, "PrivateAccessSubnet": { "description": "Description of a Virtual Network subnet that is useable for private site access.", "type": "object", "properties": { "name": { "description": "The name of the subnet.", "type": "string" }, "key": { "format": "int32", "description": "The key (ID) of the subnet.", "type": "integer" } } }, "PrivateAccessVirtualNetwork": { "description": "Description of a Virtual Network that is useable for private site access.", "type": "object", "properties": { "name": { "description": "The name of the Virtual Network.", "type": "string" }, "key": { "format": "int32", "description": "The key (ID) of the Virtual Network.", "type": "integer" }, "resourceId": { "description": "The ARM uri of the Virtual Network", "type": "string" }, "subnets": { "description": "A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.", "type": "array", "items": { "$ref": "#/definitions/PrivateAccessSubnet" } } } }, "ProcessInfo": { "description": "Process Information.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "ProcessInfo resource specific properties", "properties": { "identifier": { "format": "int32", "description": "ARM Identifier for deployment.", "type": "integer", "readOnly": true }, "deployment_name": { "description": "Deployment name.", "type": "string" }, "href": { "description": "HRef URI.", "type": "string" }, "minidump": { "description": "Minidump URI.", "type": "string" }, "is_profile_running": { "description": "Is profile running?", "type": "boolean" }, "is_iis_profile_running": { "description": "Is the IIS Profile running?", "type": "boolean" }, "iis_profile_timeout_in_seconds": { "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" } }, "threads": { "description": "Thread list.", "type": "array", "items": { "$ref": "#/definitions/ProcessThreadInfo" } }, "open_file_handles": { "description": "List of open files.", "type": "array", "items": { "type": "string" } }, "modules": { "description": "List of modules.", "type": "array", "items": { "$ref": "#/definitions/ProcessModuleInfo" } }, "file_name": { "description": "File name of this process.", "type": "string" }, "command_line": { "description": "Command line.", "type": "string" }, "user_name": { "description": "User name.", "type": "string" }, "handle_count": { "format": "int32", "description": "Handle count.", "type": "integer" }, "module_count": { "format": "int32", "description": "Module count.", "type": "integer" }, "thread_count": { "format": "int32", "description": "Thread count.", "type": "integer" }, "start_time": { "format": "date-time", "description": "Start time.", "type": "string" }, "total_cpu_time": { "description": "Total CPU time.", "type": "string" }, "user_cpu_time": { "description": "User CPU time.", "type": "string" }, "privileged_cpu_time": { "description": "Privileged CPU time.", "type": "string" }, "working_set": { "format": "int64", "description": "Working set.", "type": "integer" }, "peak_working_set": { "format": "int64", "description": "Peak working set.", "type": "integer" }, "private_memory": { "format": "int64", "description": "Private memory size.", "type": "integer" }, "virtual_memory": { "format": "int64", "description": "Virtual memory size.", "type": "integer" }, "peak_virtual_memory": { "format": "int64", "description": "Peak virtual memory usage.", "type": "integer" }, "paged_system_memory": { "format": "int64", "description": "Paged system memory.", "type": "integer" }, "non_paged_system_memory": { "format": "int64", "description": "Non-paged system memory.", "type": "integer" }, "paged_memory": { "format": "int64", "description": "Paged memory.", "type": "integer" }, "peak_paged_memory": { "format": "int64", "description": "Peak paged memory.", "type": "integer" }, "time_stamp": { "format": "date-time", "description": "Time stamp.", "type": "string" }, "environment_variables": { "description": "List of environment variables.", "type": "object", "additionalProperties": { "type": "string" } }, "is_scm_site": { "description": "Is this the SCM site?", "type": "boolean" }, "is_webjob": { "description": "Is this a Web Job?", "type": "boolean" }, "description": { "description": "Description of process.", "type": "string" } }, "x-ms-client-flatten": true } } }, "ProcessInfoCollection": { "description": "Collection of Kudu process information elements.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/ProcessInfo" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "ProcessModuleInfo": { "description": "Process Module Information.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "ProcessModuleInfo resource specific properties", "properties": { "base_address": { "description": "Base address. Used as module identifier in ARM resource URI.", "type": "string" }, "file_name": { "description": "File name.", "type": "string" }, "href": { "description": "HRef URI.", "type": "string" }, "file_path": { "description": "File path.", "type": "string" }, "module_memory_size": { "format": "int32", "description": "Module memory size.", "type": "integer" }, "file_version": { "description": "File version.", "type": "string" }, "file_description": { "description": "File description.", "type": "string" }, "product": { "description": "Product name.", "type": "string" }, "product_version": { "description": "Product version.", "type": "string" }, "is_debug": { "description": "Is debug?", "type": "boolean" }, "language": { "description": "Module language (locale).", "type": "string" } }, "x-ms-client-flatten": true } } }, "ProcessModuleInfoCollection": { "description": "Collection of Kudu thread information elements.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/ProcessModuleInfo" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "ProcessThreadInfo": { "description": "Process Thread Information.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "ProcessThreadInfo resource specific properties", "properties": { "identifier": { "format": "int32", "description": "Site extension ID.", "type": "integer", "readOnly": true }, "href": { "description": "HRef URI.", "type": "string" }, "process": { "description": "Process URI.", "type": "string" }, "start_address": { "description": "Start address.", "type": "string" }, "current_priority": { "format": "int32", "description": "Current thread priority.", "type": "integer" }, "priority_level": { "description": "Thread priority level.", "type": "string" }, "base_priority": { "format": "int32", "description": "Base priority.", "type": "integer" }, "start_time": { "format": "date-time", "description": "Start time.", "type": "string" }, "total_processor_time": { "description": "Total processor time.", "type": "string" }, "user_processor_time": { "description": "User processor time.", "type": "string" }, "priviledged_processor_time": { "description": "Privileged processor time.", "type": "string" }, "state": { "description": "Thread state.", "type": "string" }, "wait_reason": { "description": "Wait reason.", "type": "string" } }, "x-ms-client-flatten": true } } }, "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", "readOnly": true } } }, "PublicCertificate": { "description": "Public certificate object", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "PublicCertificate resource specific properties", "properties": { "blob": { "format": "byte", "description": "Public Certificate byte array", "type": "string" }, "publicCertificateLocation": { "description": "Public Certificate Location", "enum": [ "CurrentUserMy", "LocalMachineMy", "Unknown" ], "type": "string", "x-ms-enum": { "name": "PublicCertificateLocation", "modelAsString": false } }, "thumbprint": { "description": "Certificate Thumbprint", "type": "string", "readOnly": true } }, "x-ms-client-flatten": true } } }, "PublicCertificateCollection": { "description": "Collection of public certificates", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/PublicCertificate" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "RelayServiceConnectionEntity": { "description": "Hybrid Connection for an App Service app.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "RelayServiceConnectionEntity resource specific properties", "properties": { "entityName": { "type": "string" }, "entityConnectionString": { "type": "string" }, "resourceType": { "type": "string" }, "resourceConnectionString": { "type": "string" }, "hostname": { "type": "string" }, "port": { "format": "int32", "type": "integer" }, "biztalkUri": { "type": "string" } }, "x-ms-client-flatten": true } } }, "RestoreRequest": { "description": "Description of a restore request.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "RestoreRequest resource specific properties", "required": [ "storageAccountUrl", "overwrite" ], "properties": { "storageAccountUrl": { "description": "SAS URL to the container.", "type": "string" }, "blobName": { "description": "Name of a blob which contains the backup.", "type": "string" }, "overwrite": { "description": "true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.", "type": "boolean" }, "siteName": { "description": "Name of an app.", "type": "string" }, "databases": { "description": "Collection of databases which should be restored. This list has to match the list of databases included in the backup.", "type": "array", "items": { "$ref": "#/definitions/DatabaseBackupSetting" } }, "ignoreConflictingHostNames": { "description": "Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to \nthe app's object when it is being restored, but that might fail due to conflicts during the operation.", "default": false, "type": "boolean" }, "ignoreDatabases": { "description": "Ignore the databases and only restore the site content", "default": false, "type": "boolean" }, "appServicePlan": { "description": "Specify app service plan that will own restored site.", "type": "string" }, "operationType": { "description": "Operation type.", "default": "Default", "enum": [ "Default", "Clone", "Relocation", "Snapshot", "CloudFS" ], "type": "string", "x-ms-enum": { "name": "BackupRestoreOperationType", "modelAsString": false } }, "adjustConnectionStrings": { "description": "true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.", "type": "boolean" }, "hostingEnvironment": { "description": "App Service Environment name, if needed (only when restoring an app to an App Service Environment).", "type": "string" } }, "x-ms-client-flatten": true } } }, "SiteAuthSettings": { "description": "Configuration settings for the Azure App Service Authentication / Authorization feature.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SiteAuthSettings resource specific properties", "properties": { "enabled": { "description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.", "type": "boolean" }, "runtimeVersion": { "description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module.", "type": "string" }, "unauthenticatedClientAction": { "description": "The action to take when an unauthenticated client attempts to access the app.", "enum": [ "RedirectToLoginPage", "AllowAnonymous" ], "type": "string", "x-ms-enum": { "name": "UnauthenticatedClientAction", "modelAsString": false } }, "tokenStoreEnabled": { "description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false.", "type": "boolean" }, "allowedExternalRedirectUrls": { "description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.", "type": "array", "items": { "type": "string" } }, "defaultProvider": { "description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\".", "enum": [ "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter" ], "type": "string", "x-ms-enum": { "name": "BuiltInAuthenticationProvider", "modelAsString": false } }, "tokenRefreshExtensionHours": { "format": "double", "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours.", "type": "number" }, "clientId": { "description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", "type": "string" }, "clientSecret": { "description": "The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", "type": "string" }, "clientSecretCertificateThumbprint": { "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional.", "type": "string" }, "issuer": { "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html", "type": "string" }, "validateIssuer": { "description": "Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.", "type": "boolean" }, "allowedAudiences": { "description": "Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting.", "type": "array", "items": { "type": "string" } }, "additionalLoginParams": { "description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".", "type": "array", "items": { "type": "string" } }, "googleClientId": { "description": "The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/", "type": "string" }, "googleClientSecret": { "description": "The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/", "type": "string" }, "googleOAuthScopes": { "description": "The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/", "type": "array", "items": { "type": "string" } }, "facebookAppId": { "description": "The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login", "type": "string" }, "facebookAppSecret": { "description": "The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login", "type": "string" }, "facebookOAuthScopes": { "description": "The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login", "type": "array", "items": { "type": "string" } }, "twitterConsumerKey": { "description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in", "type": "string" }, "twitterConsumerSecret": { "description": "The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in", "type": "string" }, "microsoftAccountClientId": { "description": "The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm", "type": "string" }, "microsoftAccountClientSecret": { "description": "The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm", "type": "string" }, "microsoftAccountOAuthScopes": { "description": "The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx", "type": "array", "items": { "type": "string" } } }, "x-ms-client-flatten": true } } }, "SiteCloneability": { "description": "Represents whether or not an app is cloneable.", "type": "object", "properties": { "result": { "description": "Name of app.", "enum": [ "Cloneable", "PartiallyCloneable", "NotCloneable" ], "type": "string", "x-ms-enum": { "name": "CloneAbilityResult", "modelAsString": false } }, "blockingFeatures": { "description": "List of features enabled on app that prevent cloning.", "type": "array", "items": { "$ref": "#/definitions/SiteCloneabilityCriterion" } }, "unsupportedFeatures": { "description": "List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned\nbut the features in this list will not be set up on cloned app.", "type": "array", "items": { "$ref": "#/definitions/SiteCloneabilityCriterion" } }, "blockingCharacteristics": { "description": "List of blocking application characteristics.", "type": "array", "items": { "$ref": "#/definitions/SiteCloneabilityCriterion" } } } }, "SiteCloneabilityCriterion": { "description": "An app cloneability criterion.", "type": "object", "properties": { "name": { "description": "Name of criterion.", "type": "string" }, "description": { "description": "Description of criterion.", "type": "string" } } }, "SiteConfigResource": { "description": "Web app configuration ARM resource.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/SiteConfig", "description": "Core resource properties", "x-ms-client-flatten": true } } }, "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", "readOnly": true } } }, "SiteConfigurationSnapshotInfo": { "description": "A snapshot of a web app configuration.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/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 }, "snapshotId": { "format": "int32", "description": "The id of the snapshot", "type": "integer", "readOnly": true } }, "x-ms-client-flatten": true } } }, "SiteConfigurationSnapshotInfoCollection": { "description": "Collection of metadata for the app configuration snapshots that can be restored.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/SiteConfigurationSnapshotInfo" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "SiteExtensionInfo": { "description": "Site Extension Information.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SiteExtensionInfo resource specific properties", "properties": { "extension_id": { "description": "Site extension ID.", "type": "string" }, "title": { "type": "string" }, "extension_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" }, "extension_url": { "description": "Extension URL.", "type": "string" }, "project_url": { "description": "Project URL.", "type": "string" }, "icon_url": { "description": "Icon URL.", "type": "string" }, "license_url": { "description": "License URL.", "type": "string" }, "feed_url": { "description": "Feed URL.", "type": "string" }, "authors": { "description": "List of authors.", "type": "array", "items": { "type": "string" } }, "installer_command_line_params": { "description": "Installer command line parameters.", "type": "string" }, "published_date_time": { "format": "date-time", "description": "Published timestamp.", "type": "string" }, "download_count": { "format": "int32", "description": "Count of downloads.", "type": "integer" }, "local_is_latest_version": { "description": "true if the local version is the latest version; false otherwise.", "type": "boolean" }, "local_path": { "description": "Local path.", "type": "string" }, "installed_date_time": { "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" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/SiteExtensionInfo" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "SiteInstance": { "description": "Instance of an app.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SiteInstance resource specific properties", "properties": { "siteInstanceName": { "description": "Name of instance.", "type": "string", "readOnly": true } }, "x-ms-client-flatten": true } } }, "SiteLogsConfig": { "description": "Configuration of App Service site logs.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SiteLogsConfig resource specific properties", "properties": { "applicationLogs": { "$ref": "#/definitions/ApplicationLogsConfig", "description": "Application logs configuration." }, "httpLogs": { "$ref": "#/definitions/HttpLogsConfig", "description": "HTTP logs configuration." }, "failedRequestsTracing": { "$ref": "#/definitions/EnabledConfig", "description": "Failed requests tracing configuration." }, "detailedErrorMessages": { "$ref": "#/definitions/EnabledConfig", "description": "Detailed error messages configuration." } }, "x-ms-client-flatten": true } } }, "SitePatchResource": { "description": "ARM resource for a site.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SitePatchResource resource specific properties", "properties": { "state": { "description": "Current state of the app.", "type": "string", "readOnly": true }, "hostNames": { "description": "Hostnames associated with the app.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "repositorySiteName": { "description": "Name of the repository site.", "type": "string", "readOnly": true }, "usageState": { "description": "State indicating whether the app has exceeded its quota usage. Read-only.", "enum": [ "Normal", "Exceeded" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "UsageState", "modelAsString": false } }, "enabled": { "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).", "type": "boolean" }, "enabledHostNames": { "description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "availabilityState": { "description": "Management information availability state for the app.", "enum": [ "Normal", "Limited", "DisasterRecoveryMode" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "SiteAvailabilityState", "modelAsString": false } }, "hostNameSslStates": { "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.", "type": "array", "items": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HostNameSslState" } }, "serverFarmId": { "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".", "type": "string" }, "reserved": { "description": "true if reserved; otherwise, false.", "default": false, "type": "boolean", "x-ms-mutability": [ "create", "read" ] }, "isXenon": { "description": "Obsolete: Hyper-V sandbox.", "default": false, "type": "boolean", "x-ms-mutability": [ "create", "read" ] }, "hyperV": { "description": "Hyper-V sandbox.", "default": false, "type": "boolean", "x-ms-mutability": [ "create", "read" ] }, "lastModifiedTimeUtc": { "format": "date-time", "description": "Last time the app was modified, in UTC. Read-only.", "type": "string", "readOnly": true }, "siteConfig": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/SiteConfig", "description": "Configuration of the app." }, "trafficManagerHostNames": { "description": "Azure Traffic Manager hostnames associated with the app. Read-only.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "scmSiteAlsoStopped": { "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.", "default": false, "type": "boolean" }, "targetSwapSlot": { "description": "Specifies which deployment slot this app will swap into. Read-only.", "type": "string", "readOnly": true }, "hostingEnvironmentProfile": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/HostingEnvironmentProfile", "description": "App Service Environment to use for the app.", "x-ms-mutability": [ "create", "read" ] }, "clientAffinityEnabled": { "description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.", "type": "boolean" }, "clientCertEnabled": { "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.", "type": "boolean" }, "clientCertExclusionPaths": { "description": "client certificate authentication comma-separated exclusion paths", "type": "string" }, "hostNamesDisabled": { "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.", "type": "boolean" }, "outboundIpAddresses": { "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.", "type": "string", "readOnly": true }, "possibleOutboundIpAddresses": { "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.", "type": "string", "readOnly": true }, "containerSize": { "format": "int32", "description": "Size of the function container.", "type": "integer" }, "dailyMemoryTimeQuota": { "format": "int32", "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).", "type": "integer" }, "suspendedTill": { "format": "date-time", "description": "App suspended till in case memory-time quota is exceeded.", "type": "string", "readOnly": true }, "maxNumberOfWorkers": { "format": "int32", "description": "Maximum number of workers.\nThis only applies to Functions container.", "type": "integer", "readOnly": true }, "cloningInfo": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/CloningInfo", "description": "If specified during app creation, the app is cloned from a source app.", "x-ms-mutability": [ "create" ] }, "resourceGroup": { "description": "Name of the resource group the app belongs to. Read-only.", "type": "string", "readOnly": true }, "isDefaultContainer": { "description": "true if the app is a default container; otherwise, false.", "type": "boolean", "readOnly": true }, "defaultHostName": { "description": "Default hostname of the app. Read-only.", "type": "string", "readOnly": true }, "slotSwapStatus": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/SlotSwapStatus", "description": "Status of the last deployment slot swap operation.", "readOnly": true }, "httpsOnly": { "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests", "type": "boolean" }, "redundancyMode": { "description": "Site redundancy mode", "enum": [ "None", "Manual", "Failover", "ActiveActive", "GeoRedundant" ], "type": "string", "x-ms-enum": { "name": "RedundancyMode", "modelAsString": false } }, "inProgressOperationId": { "format": "uuid", "description": "Specifies an operation id if this site has a pending operation.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "geoDistributions": { "description": "GeoDistributions for this site", "type": "array", "items": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/GeoDistribution" } } }, "x-ms-client-flatten": true }, "identity": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ManagedServiceIdentity" } } }, "SitePhpErrorLogFlag": { "description": "Used for getting PHP error logging flag.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SitePhpErrorLogFlag resource specific properties", "properties": { "localLogErrors": { "description": "Local log_errors setting.", "type": "string" }, "masterLogErrors": { "description": "Master log_errors setting.", "type": "string" }, "localLogErrorsMaxLength": { "description": "Local log_errors_max_len setting.", "type": "string" }, "masterLogErrorsMaxLength": { "description": "Master log_errors_max_len setting.", "type": "string" } }, "x-ms-client-flatten": true } } }, "SiteSourceControl": { "description": "Source control configuration for an app.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SiteSourceControl resource specific properties", "properties": { "repoUrl": { "description": "Repository or source control URL.", "type": "string", "x-ms-mutability": [ "create", "read" ] }, "branch": { "description": "Name of branch to use for deployment.", "type": "string", "x-ms-mutability": [ "create", "read" ] }, "isManualIntegration": { "description": "true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).", "type": "boolean", "x-ms-mutability": [ "create", "read" ] }, "deploymentRollbackEnabled": { "description": "true to enable deployment rollback; otherwise, false.", "type": "boolean", "x-ms-mutability": [ "create", "read" ] }, "isMercurial": { "description": "true for a Mercurial repository; false for a Git repository.", "type": "boolean", "x-ms-mutability": [ "create", "read" ] } }, "x-ms-client-flatten": true } } }, "SlotConfigNames": { "description": "Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app.", "type": "object", "properties": { "connectionStringNames": { "description": "List of connection string names.", "type": "array", "items": { "type": "string" } }, "appSettingNames": { "description": "List of application settings names.", "type": "array", "items": { "type": "string" } }, "azureStorageConfigNames": { "description": "List of external Azure storage account identifiers.", "type": "array", "items": { "type": "string" } } } }, "SlotConfigNamesResource": { "description": "Slot Config names azure resource.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "$ref": "#/definitions/SlotConfigNames", "description": "Core resource properties", "x-ms-client-flatten": true } } }, "SlotDifference": { "description": "A setting difference between two deployment slots of an app.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SlotDifference resource specific properties", "properties": { "level": { "description": "Level of the difference: Information, Warning or Error.", "type": "string", "readOnly": true }, "settingType": { "description": "The type of the setting: General, AppSetting or ConnectionString.", "type": "string", "readOnly": true }, "diffRule": { "description": "Rule that describes how to process the setting difference during a slot swap.", "type": "string", "readOnly": true }, "settingName": { "description": "Name of the setting.", "type": "string", "readOnly": true }, "valueInCurrentSlot": { "description": "Value of the setting in the current slot.", "type": "string", "readOnly": true }, "valueInTargetSlot": { "description": "Value of the setting in the target slot.", "type": "string", "readOnly": true }, "description": { "description": "Description of the setting difference.", "type": "string", "readOnly": true } }, "x-ms-client-flatten": true } } }, "SlotDifferenceCollection": { "description": "Collection of slot differences.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/SlotDifference" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "SnapshotCollection": { "description": "Collection of snapshots which can be used to revert an app to a previous time.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/Snapshot" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "SnapshotRecoverySource": { "description": "Specifies the web app that snapshot contents will be retrieved from.", "type": "object", "properties": { "location": { "description": "Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS", "type": "string" }, "id": { "description": "ARM resource ID of the source app. \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.", "type": "string" } } }, "SnapshotRestoreRequest": { "description": "Details about app recovery operation.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SnapshotRestoreRequest resource specific properties", "required": [ "overwrite" ], "properties": { "snapshotTime": { "description": "Point in time in which the app restore should be done, formatted as a DateTime string.", "type": "string" }, "recoverySource": { "$ref": "#/definitions/SnapshotRecoverySource", "description": "Optional. Specifies the web app that snapshot contents will be retrieved from.\nIf empty, the targeted web app will be used as the source." }, "overwrite": { "description": "If true the restore operation can overwrite source app; otherwise, false.", "type": "boolean" }, "recoverConfiguration": { "description": "If true, site configuration, in addition to content, will be reverted.", "type": "boolean" }, "ignoreConflictingHostNames": { "description": "If true, custom hostname conflicts will be ignored when recovering to a target web app.\nThis setting is only necessary when RecoverConfiguration is enabled.", "type": "boolean" }, "useDRSecondary": { "description": "If true, the snapshot is retrieved from DRSecondary endpoint.", "type": "boolean" } }, "x-ms-client-flatten": true } } }, "StorageMigrationOptions": { "description": "Options for app content migration.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "StorageMigrationOptions resource specific properties", "required": [ "azurefilesConnectionString", "azurefilesShare" ], "properties": { "azurefilesConnectionString": { "description": "AzureFiles connection string.", "type": "string", "x-ms-mutability": [ "create" ] }, "azurefilesShare": { "description": "AzureFiles share.", "type": "string", "x-ms-mutability": [ "create" ] }, "switchSiteAfterMigration": { "description": "trueif the app should be switched over; otherwise, false.", "default": false, "type": "boolean", "x-ms-mutability": [ "create" ] }, "blockWriteAccessToSite": { "description": "true if the app should be read only during copy operation; otherwise, false.", "default": false, "type": "boolean", "x-ms-mutability": [ "create" ] } }, "x-ms-client-flatten": true } } }, "StorageMigrationResponse": { "description": "Response for a migration of app content request.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "StorageMigrationResponse resource specific properties", "properties": { "operationId": { "description": "When server starts the migration process, it will return an operation ID identifying that particular migration operation.", "type": "string", "readOnly": true } }, "x-ms-client-flatten": true } } }, "StringDictionary": { "description": "String dictionary resource.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "Settings.", "type": "object", "additionalProperties": { "type": "string" }, "x-ms-client-flatten": true } } }, "SwiftVirtualNetwork": { "description": "Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "SwiftVirtualNetwork resource specific properties", "properties": { "subnetResourceId": { "description": "The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.", "type": "string" }, "swiftSupported": { "description": "A flag that specifies if the scale unit this Web App is on supports Swift integration.", "type": "boolean" } }, "x-ms-client-flatten": true } } }, "TriggeredJobHistory": { "description": "Triggered Web Job History. List of Triggered Web Job Run Information elements.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "TriggeredJobHistory resource specific properties", "properties": { "runs": { "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", "readOnly": true } } }, "TriggeredJobRun": { "description": "Triggered Web Job Run Information.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "TriggeredJobRun resource specific properties", "properties": { "web_job_id": { "description": "Job ID.", "type": "string" }, "web_job_name": { "description": "Job name.", "type": "string" }, "status": { "description": "Job status.", "enum": [ "Success", "Failed", "Error" ], "type": "string", "x-ms-enum": { "name": "TriggeredWebJobStatus", "modelAsString": false } }, "start_time": { "format": "date-time", "description": "Start time.", "type": "string" }, "end_time": { "format": "date-time", "description": "End time.", "type": "string" }, "duration": { "description": "Job duration.", "type": "string" }, "output_url": { "description": "Output URL.", "type": "string" }, "error_url": { "description": "Error URL.", "type": "string" }, "url": { "description": "Job URL.", "type": "string" }, "job_name": { "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": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "TriggeredWebJob resource specific properties", "properties": { "latest_run": { "$ref": "#/definitions/TriggeredJobRun", "description": "Latest job run information." }, "history_url": { "description": "History URL.", "type": "string" }, "scheduler_logs_url": { "description": "Scheduler Logs URL.", "type": "string" }, "run_command": { "description": "Run command.", "type": "string" }, "url": { "description": "Job URL.", "type": "string" }, "extra_info_url": { "description": "Extra Info URL.", "type": "string" }, "web_job_type": { "description": "Job type.", "enum": [ "Continuous", "Triggered" ], "type": "string", "x-ms-enum": { "name": "WebJobType", "modelAsString": false } }, "error": { "description": "Error information.", "type": "string" }, "using_sdk": { "description": "Using SDK?", "type": "boolean" }, "settings": { "description": "Job settings.", "type": "object", "additionalProperties": { "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", "readOnly": true } } }, "WebAppInstanceCollection": { "description": "Collection of app instances.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/SiteInstance" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "WebJob": { "description": "Web Job Information.", "type": "object", "allOf": [ { "$ref": "../2018-02-01/CommonDefinitions.json#/definitions/ProxyOnlyResource" } ], "properties": { "properties": { "description": "WebJob resource specific properties", "properties": { "run_command": { "description": "Run command.", "type": "string" }, "url": { "description": "Job URL.", "type": "string" }, "extra_info_url": { "description": "Extra Info URL.", "type": "string" }, "web_job_type": { "description": "Job type.", "enum": [ "Continuous", "Triggered" ], "type": "string", "x-ms-enum": { "name": "WebJobType", "modelAsString": false } }, "error": { "description": "Error information.", "type": "string" }, "using_sdk": { "description": "Using SDK?", "type": "boolean" }, "settings": { "description": "Job settings.", "type": "object", "additionalProperties": { "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", "readOnly": true } } } }, "parameters": { "subscriptionIdParameter": { "name": "subscriptionId", "in": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", "required": true, "type": "string" }, "resourceGroupNameParameter": { "name": "resourceGroupName", "in": "path", "description": "Name of the resource group to which the resource belongs.", "required": true, "type": "string", "maxLength": 90, "minLength": 1, "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", "x-ms-parameter-location": "method" }, "apiVersionParameter": { "name": "api-version", "in": "query", "description": "API Version", "required": true, "type": "string" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ] }