Databases - Rename

Service:: SQL Database

API Version:: 2023-08-01

Renames a database.

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

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	ErrorResponse	* 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 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters. 400 TokenTooLong - The provided token is too long. 400 DatabaseNameInUse - Database already exists. Choose a different database name. 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account. 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation. 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 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.

Name

Type

Description

200 OK

Successfully renamed the database.

Other Status Codes

ErrorResponse

*** 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 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.
400 TokenTooLong - The provided token is too long.
400 DatabaseNameInUse - Database already exists. Choose a different database name.
400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.
400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.
400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.
400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.
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.

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=2023-08-01

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/RenameDatabase.json
// this example is just showing the usage of "Databases_Rename" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
SqlResourceMoveDefinition sqlResourceMoveDefinition = new SqlResourceMoveDefinition(new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/newtestdb"));
await sqlDatabase.RenameAsync(sqlResourceMoveDefinition);

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ResourceMoveDefinition	Contains the information necessary to perform a resource move (rename).

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ResourceMoveDefinition

Object

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

Name	Type	Description
id	string	The target ID for the resource

Share via

Databases - Rename

URI Parameters

Request Body

Responses

Examples

Renames a database.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ResourceMoveDefinition