Share via

Web Apps - Migrate My Sql

Service:
App Service
API Version:
2025-03-01

Description for Migrates a local (in-app) MySql database to a remote MySql database.

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

URI Parameters

Name In Required Type Description
name
 path True

string

Name of web app.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+[^\.]$

Name of the resource group to which the resource belongs.
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
properties.connectionString True

string

Connection string to the remote MySQL database.
properties.migrationType True

MySqlMigrationType

The type of migration operation to be done
kind

string

Kind of resource.

Responses

Name Type Description
200 OK

Operation

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.
ErrorEntity

Body of the error response returned from the API.
MigrateMySqlRequest

MySQL migration request.
MySqlMigrationType

The type of migration operation to be done
Operation

An operation on a resource.
OperationStatus

Status of the migration task.

DefaultErrorResponse

Object

App Service error response.

Name Type Description
error

Error

Error model.

Details

Object
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

Object

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.

ErrorEntity

Object

Body of the error response returned from the API.

Name Type Description
code

string

Basic error code.
details

ErrorEntity[]

Error Details.
extendedCode

string

Type of error.
innerErrors

ErrorEntity[]

Inner errors.
message

string

Any details of the error.
messageTemplate

string

Message template.
parameters

string[]

Parameters for the template.
target

string

The error target.

MigrateMySqlRequest

Object

MySQL migration request.

Name Type Description
id

string

Resource Id.
kind

string

Kind of resource.
name

string

Resource Name.
properties.connectionString

string

Connection string to the remote MySQL database.
properties.migrationType

MySqlMigrationType

The type of migration operation to be done
type

string

Resource type.

MySqlMigrationType

Enumeration

The type of migration operation to be done

Value Description
LocalToRemote
RemoteToLocal

Operation

Object

An operation on a resource.

Name Type Description
createdTime

string (date-time)

Time when operation has started.
errors

ErrorEntity[]

Any errors associate with the operation.
expirationTime

string (date-time)

Time when operation will expire.
geoMasterOperationId

string (uuid)

Applicable only for stamp operation ids.
id

string

Operation ID.
modifiedTime

string (date-time)

Time when operation has been updated.
name

string

Operation name.
status

OperationStatus

The current status of the operation.

OperationStatus

Enumeration

Status of the migration task.

Value Description
InProgress
Failed
Succeeded
TimedOut
Created