Databases - Rename

  • Reference
Service:
SQL Database
API Version:
2021-02-01-preview

Renames a database.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/move?api-version=2021-02-01-preview

URI Parameters

Name In Required Type Description
databaseName
 path True

string

The name of the database to rename.
resourceGroupName
 path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
 path True

string

The name of the server.
subscriptionId
 path True

string

The subscription ID that identifies an Azure subscription.
api-version
 query True

string

The API version to use for the request.

Request Body

Name Required Type Description
id True

string

The target ID for the resource

Responses

Name Type Description
200 OK

Successfully renamed the database.
Other Status Codes

*** Error Responses: ***

  • 400 InvalidResourceMoveRequest - The resource move request is invalid.

  • 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.

  • 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.

  • 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.

  • 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.

  • 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.

  • 400 DatabaseNameInUse - Database already exists. Choose a different database name.

  • 400 TokenTooLong - The provided token is too long.

  • 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.

  • 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.

  • 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.

  • 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.

  • 404 SourceDatabaseNotFound - The source database does not exist.

  • 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.

Examples

Renames a database.

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/move?api-version=2021-02-01-preview

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/newtestdb"
}

Sample Response

Status code:
200

Definitions

ResourceMoveDefinition

Contains the information necessary to perform a resource move (rename).

Name Type Description
id

string

The target ID for the resource