Web Apps - Migrate Storage

Service:

App Service

API Version:

2024-04-01

Description for Restores a web app.

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of web 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
subscriptionName	query	True	string	Azure subscription.

Request Body

Name	Required	Type	Description
properties.azurefilesConnectionString	True	string	AzureFiles connection string.
properties.azurefilesShare	True	string	AzureFiles share.
kind		string	Kind of resource.
properties.blockWriteAccessToSite		boolean	true if the app should be read only during copy operation; otherwise, false.
properties.switchSiteAfterMigration		boolean	trueif the app should be switched over; otherwise, false.

Responses

Name	Type	Description
200 OK	StorageMigrationResponse	OK
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
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
StorageMigrationOptions	Options for app content migration.
StorageMigrationResponse	Response for a migration of app content request.

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.

StorageMigrationOptions

Options for app content migration.

Name	Type	Default value	Description
id	string		Resource Id.
kind	string		Kind of resource.
name	string		Resource Name.
properties.azurefilesConnectionString	string		AzureFiles connection string.
properties.azurefilesShare	string		AzureFiles share.
properties.blockWriteAccessToSite	boolean	False	true if the app should be read only during copy operation; otherwise, false.
properties.switchSiteAfterMigration	boolean	False	trueif the app should be switched over; otherwise, false.
type	string		Resource type.

StorageMigrationResponse

Response for a migration of app content request.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.operationId	string	When server starts the migration process, it will return an operation ID identifying that particular migration operation.
type	string	Resource type.