About the Windows Azure SQL Database Management API
The SQL Database Management API provides programmatic access to the same management operations performed through the Windows Azure Platform Management Portal to manage SQL Database servers. Using the SQL Database Management API, you can manage SQL Database servers for each subscription and the firewall rules associated to each server. This is useful for automating an application’s database support without interacting directly with the Management Portal.
The Database Management API is a REST API. All operation requests are sent encrypted over the Secure Sockets Layer (SSL) and authenticated using X.509 v3 certificates. Database Management API requests can be initiated from within Windows Azure, or directly over the internet from any application that can send HTTPS requests and receive HTTPS responses. All requests are sent to the SQL Database Management Service on port 8443 using the following base URL: https://management.database.windows.net:8443
For more information about certificates, see Certificates.
For more information about authenticating SQL Database Management API requests with certificates see, Authenticating Windows Azure SQL Database Management API Requests.
The URL for SQL Database Management API Requests
The URL for the each operation supported by the SQL Database Management API is shown in the following table. As shown in each URL in the table below, the SQL Database Management Service listens on port 8443. The required HTTP method to use with each URL is also given in the table below along with any XML schema required in the request body. Code examples for using the URLs are also provided in the sections that follow.
| Description | URL | HTTP Method Used | XML Schema used in the request body |
|---|---|---|---|
|
Operation request to enumerate SQL Database servers for a subscription |
|
GET |
None |
|
Operation request to create a SQL Database server for a subscription |
|
POST |
http://schemas.microsoft.com/sqlazure/2010/12/ Server.xsd |
|
Operation request to drop a SQL Database server for a subscription |
|
DELETE |
None |
|
Operation request to set the administrative password for a SQL Database server |
|
POST |
http://schemas.microsoft.com/sqlazure/2010/12/ ResetServerPassword.xsd |
|
Operation request to enumerate the firewall rules for a SQL Database server |
|
GET |
None |
|
Operation request to create a new firewall rule, or update the IP address range of an existing firewall rule for a SQL Database server |
|
PUT |
http://schemas.microsoft.com/sqlazure/2010/12/ FirewallRule.xsd |
|
Operation request to create a new firewall rule, or update the IP address range of an existing firewall rule for a SQL Database server, using the IP address of the client |
|
POST |
None |
|
Operation request to delete a firewall rule for a SQL Database server |
|
DELETE |
None |
Managing SQL Database Servers
The SQL Database Management API provides the functionality to manage SQL Database servers. These sections provide the complete technical reference for each operation along with code examples for submitting operation requests.
| Section | Description |
|---|---|
|
Demonstrates how to create SQL Database servers using the SQL Database Management API |
|
|
Demonstrates how to drop SQL Database servers using the SQL Database Management API. |
|
|
Demonstrates how to enumerate all SQL Database servers currently provisioned for a subscription, using the SQL Database Management API. |
|
|
Demonstrates how to manage administrative passwords for a SQL Database server, using the SQL Database Management API. |
Managing Server-Level Firewall Rules for SQL Database Servers
The SQL Database Management API provides the functionality to manage the server-level firewall rules that restrict access to SQL Database servers. These sections provide the complete technical reference for each operation along with code examples for submitting operation requests.
| Section | Description |
|---|---|
|
Demonstrates how to create server-level firewall rules by using the SQL Database Management API. |
|
|
Creating Server-Level Firewall Rules for Servers with IP Detect |
Demonstrates how to create server-level firewall rules by using the SQL Database Management API, with the IP address of the client automatically added to the rule. |
|
Demonstrates how to list all the active server-level firewall rules by using the SQL Database Management API. |
|
|
Demonstrates how to delete server-level firewall rules by using the SQL Database Management API. |
For information about the server-level firewall rules in SQL Database, see Windows Azure SQL Database Firewall.
Asynchronous REST API Call Support
The SQL Database Management Service does not support asynchronous REST API calls.
See Also