List Servers (classic)

 

Updated: October 5, 2016

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

Retrieves the Azure SQL Database servers for a given 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.

The List Servers request must be specified as follows:

  • Replace {subscriptionId} with your subscription ID. contentview=generic is optional.
MethodRequest URIHTTP Version
GEThttps://management.core.windows.net:8443/{subscriptionId}/services/sqlservers/servers?contentview=genericHTTP/1.1
GEThttps://management.core.windows.net:8443/{subscriptionId}/services/sqlservers/serversHTTP/1.1

URI Parameters

None.

Request Headers

The following table describes the required and optional request headers:

Request HeaderDescription
x-ms-versionRequired. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01.

Request Body

None.

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

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 HeaderDescription
x-ms-request-idA 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

The following is an example response body when contentview=generic is used:

<ServiceResources xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
  <ServiceResource>  
    <Name>asnk4if9pe</Name>  
    <Type>Microsoft.SqlAzure.Server</Type>  
    <State>Ready</State>  
    <SelfLink>https://management.core.windows.net:8443/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX/services/sqlservers/servers/asnk4if9pe</SelfLink>  
    <ParentLink i:nil="true" />  
    <FullyQualifiedDomainName>asnk4if9pe.database.windows.net</FullyQualifiedDomainName>  
    <Version>12.0</Version>  
  </ServiceResource>  
  
  <ServiceResource>  
    <Name>fwrsk85bwd</Name>  
    <Type>Microsoft.SqlAzure.Server</Type>  
    <State>Ready</State>  
    <SelfLink>https://management.core.windows.net:8443/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX/services/sqlservers/servers/fwrsk85bwd</SelfLink>  
    <ParentLink i:nil="true" />  
    <FullyQualifiedDomainName>fwrsk85bwd.database.windows.net</FullyQualifiedDomainName>  
    <Version>12.0</Version>  
  </ServiceResource>  
</ServiceResources>  

The following is an example response body when contentview=generic is not used:

<Servers xmlns=http://schemas.microsoft.com/sqlazure/2010/12/>  
  <Server>  
    <Name>asnk4if9pe</Name>  
    <AdministratorLogin>mylogin</AdministratorLogin>  
    <Location>East Asia</Location>  
    <FullyQualifiedDomainName>asnk4if9pe.database.windows.net</FullyQualifiedDomainName>  
    <Version>12.0</Version>  
    <State>Ready</State>  
  </Server>  
</Servers>  

The following console application returns a list of servers for the provided SubscriptionID.

Replace the following values:

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

  • {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 ListServer  
{  
    /// <summary>  
    /// Gets a list of servers for a subscription.  
    /// </summary>  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            Uri requestUri = new Uri("https://management.core.windows.net:8443/"  
                                   + "{subscriptionId}"  
                                   + "/services"  
                                   + "/sqlservers/servers");  
  
            // 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 = "GET";  
            request.ContentType = "application/xml";  
  
            // Replace {thumbprint} with the thumbprint of a management certificate associated with your subscription.  
            // It must 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);  
            }  
        }  
    }  
}  

Common REST API Error Codes
Azure SQL Database
Operations for Azure SQL Databases
Azure SQL Database Cmdlets

Show: