Azure SQL Database REST API Operations

This document provides a comprehensive reference for the Azure SQL Database REST API. You can use these operations to programmatically manage your Azure SQL databases, servers, and related resources.

Resource Management Operations

These operations allow you to manage the fundamental resources within Azure SQL Database.

Servers

HTTP Method Path Description
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers Lists all SQL Servers in a resource group.
GET /subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers Lists all SQL Servers in a subscription.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName} Creates or updates a SQL Server.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName} Deletes a SQL Server.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName} Gets a SQL Server.

Databases

HTTP Method Path Description
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases Lists all databases in a server.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName} Creates or updates a database.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName} Deletes a database.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName} Gets a database.

Database Management Operations

These operations focus on managing the internal components and settings of individual databases.

Firewall Rules

HTTP Method Path Description
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules Lists all firewall rules for a server.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{ruleName} Creates or updates a firewall rule.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{ruleName} Deletes a firewall rule.

Elastic Pools

HTTP Method Path Description
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools Lists all elastic pools in a server.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName} Creates or updates an elastic pool.

Data Operations

While the REST API primarily focuses on management, some operations allow interaction with data or metadata.

Data Export/Import

Operations for initiating data export and import processes.

HTTP Method Path Description
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/"},{"operationKind":"Export" Initiates a database export operation.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName} Initiates a database import operation.

Monitoring and Auditing

APIs for accessing audit logs and performance metrics.

Auditing Policies

HTTP Method Path Description
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingPolicies Gets the auditing policy for a database.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingPolicies/{name} Creates or updates the auditing policy for a database.

Common Parameters

Many REST API requests include common parameters:

Common Response Codes

Standard HTTP response codes you might encounter:

Code Description
200 OK The request was successful.
201 Created The resource was successfully created.
202 Accepted The request has been accepted for processing, but processing is not yet complete.
204 No Content The request was successful, but there is no content to return.
400 Bad Request The request is invalid or malformed.
401 Unauthorized Authentication failed.
404 Not Found The requested resource could not be found.
409 Conflict The request conflicts with the current state of the resource.
500 Internal Server Error An error occurred on the server.

For detailed request and response body examples, please refer to the specific operation documentation within the Azure REST API documentation portal.