Web Apps - Swap Slot With Production

Service:

App Service

API Version:

2024-04-01

Description for Swaps two deployment slots of an app.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the app.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Required	Type	Description
preserveVnet	True	boolean	true to preserve Virtual Network to the slot during swap; otherwise, false.
targetSlot	True	string	Destination deployment slot during swap operation.

Responses

Name	Type	Description
200 OK		OK.
202 Accepted		Operation is in progress.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

Name	Description
CsmSlotEntity	Deployment slot parameters.
DefaultErrorResponse	App Service error response.
Details
Error	Error model.

CsmSlotEntity

Deployment slot parameters.

Name	Type	Description
preserveVnet	boolean	true to preserve Virtual Network to the slot during swap; otherwise, false.
targetSlot	string	Destination deployment slot during swap operation.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.