Change Subscription for All Servers (classic)

 

THIS TOPIC APPLIES TO: noSQL Server yesAzure SQL DatabaseyesAzure SQL Data Warehouse noParallel Data Warehouse

Move all Azure SQL Database servers from one subscription to a different subscription.

This command uses the classic deployment model. You should use the newer Resource Manager based REST API commands located here. For more information, see Azure Resource Manager vs. classic deployment: Understand deployment models and the state of your resources.

Request

The Change Subscription request must be specified as follows:

  • Replace {subscriptionId} with the source subscription ID (the target subscription ID is specified in the request body).
Method Request URI HTTP Version
POST https://management.core.windows.net:8443/{subscriptionId}/services/sqlservers/servers?op=ChangeSubscription HTTP/1.1

If the operation returns success, the operation is complete and changes are effective immediately. If the operation fails because of a user error, no changes are applied. If there is a communication error or internal server error, you should check the status of the operation using List Servers (classic).

URI Parameters

None.

Request Headers

The following table describes the required and optional request headers:

Request Header Description
x-ms-version Required. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01.
x-ms-client-request-id Optional. Provides a client-generated, opaque value with a 1 KB character limit. Using this header is highly recommended for correlating client-side activities with requests received by the server.

Request Body

The format of the request body is as follows:

<TargetSubscriptionId xmlns="http://schemas.microsoft.com/sqlazure/2010/12/">{subscriptionId}</TargetSubscriptionId>  

The following table describes the elements of the request body:

Element Name Description
TargetSubscriptionId The subscription ID to move the servers to.

Response

The response includes an HTTP status code and a set of response headers.

Status Code

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A value that uniquely identifies a request made against the database management service. This request id is used for request tracking. If a failure occurs that requires the user to contact Microsoft Support, the request id should be provided to Microsoft to assist in tracking and resolving the failure for the request.

Response Body

None.

Example

The following console application transfers all servers from one subscription to another.

Replace the following values:

  • {subscriptionId}– replace with the subscription identifier for your subscription.

  • {newSubscriptionId}– replace with the new subscription identifier to be associated with the server.

  • {thumbprint}– replace with the thumbprint of a management certificate in your subscription.

using System;  
using System.Collections.Generic;  
using System.Linq;  
using System.Text;  
using System.Threading.Tasks;  
using System.IO;  
using System.Xml;  
using System.Security;  
using System.Security.Cryptography;  
using System.Security.Cryptography.X509Certificates;  
using System.Net;  
  
namespace ChangeSubscriptionMultiple  
{  
    /// <summary>  
    /// Transfers all servers from one subscription to another.  
    /// </summary>  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            Uri requestUri = new Uri("https://management.core.windows.net:8443/"  
                                    + "{subscriptionId}"  
                                    + "/services"  
                                    + "/sqlservers/servers"  
                                    + "?op=ChangeSubscription");  
  
            // Create the request and specify attributes.  
            HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(requestUri);  
  
            // Add a x-ms-version header to specify API version.  
            request.Headers.Add("x-ms-version", "2012-03-01");  
  
            // Generate a request ID that can be used to identify this request in the service logs.  
            string clientRequestId = Guid.NewGuid().ToString();  
            request.Headers.Add("x-ms-client-request-id", clientRequestId);  
            request.Method = "POST";  
            request.ContentType = "application/xml";  
  
            // Build request body.  
            string newSubscription = "{newSubscriptionId}";  
            string xmlBody = String.Format(  
                "<TargetSubscriptionId xmlns=\"http://schemas.microsoft.com/sqlazure/2010/12/\">{0}</TargetSubscriptionId>", newSubscription);  
  
            // Write the POST body into the request.  
            ASCIIEncoding encoding = new ASCIIEncoding();  
            byte[] data = encoding.GetBytes(xmlBody);  
            Stream newStream = request.GetRequestStream();  
            newStream.Write(data, 0, data.Length);  
  
            // The thumbprint value of the management certificate.  
            // Replace {thumbprint} with the thumbprint of a management certificate associated with your subscription.  
            // It must also be installed on the machine accessing the API.  
            string certThumbprint = "{thumbprint}";  
  
            // Create a reference to the My certificate store.  
            X509Store certStore = new X509Store(StoreName.My, StoreLocation.CurrentUser);  
  
            // Open the store.  
            certStore.Open(OpenFlags.ReadOnly);  
  
            // Find the certificate that matches the thumbprint.  
            X509Certificate2Collection certCollection = certStore.Certificates.Find(X509FindType.FindByThumbprint, certThumbprint, false);  
            certStore.Close();  
  
            // Verify the certificate was added to the collection.  
            if (0 == certCollection.Count)  
            {  
                throw new Exception("Error: No certificate found with thumbprint " + certThumbprint);  
            }  
  
            // Create an X509Certificate2 object using our matching certificate.  
            X509Certificate2 certificate = certCollection[0];  
  
            // Attach the certificate to the request.  
            request.ClientCertificates.Add(certificate);  
  
            try  
            {  
                using (HttpWebResponse response = (HttpWebResponse)request.GetResponse())  
                using (Stream responseStream = response.GetResponseStream())  
                using (StreamReader reader = new StreamReader(responseStream))  
                {  
                    // Display the client request ID.  
                    Console.WriteLine("clientRequestId: " + clientRequestId);  
  
                    // Display the web response status code.  
                    Console.WriteLine("Response status code: " + response.StatusCode);  
  
                    // Display the request ID returned by Windows Azure.  
                    Console.WriteLine("x-ms-request-id: "  
                        + response.Headers["x-ms-request-id"]);  
  
                    // Display the raw response.  
                    Console.WriteLine("Received response:");  
                    Console.WriteLine(reader.ReadToEnd());  
                }  
            }  
            catch (Exception e)  
            {  
                Console.WriteLine(e.StackTrace);  
            }  
        }  
    }  
}  

See Also

Common REST API Error Codes
Operations for Azure SQL Databases
Azure SQL Database
Azure SQL Database CmdletsChange Subscription for a Single Server (classic)