Azure SQL Database REST API Reference

This document provides a comprehensive reference for the Azure SQL Database REST APIs. You can use these APIs to programmatically manage your Azure SQL Database resources, including databases, servers, firewalls, and more.

Core Resource Providers

The primary resource provider for Azure SQL Database is Microsoft.Sql. This provider exposes various types of resources that you can interact with.

API Categories

The APIs are organized into the following categories:

Databases

List Databases

Retrieves a list of all databases in a logical server.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases
Parameters
  • $filter - Optional. An OData filter expression that filters the results.
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
Success Responses
  • 200 OK - Successfully retrieved the list of databases.
Error Responses
  • 400 Bad Request - Invalid request.
  • 401 Unauthorized - Authentication failed.
  • 404 Not Found - Resource not found.

Get Database

Retrieves a specific database.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
Success Responses
  • 200 OK - Successfully retrieved the database details.

Create or Update Database

Creates or updates a database.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
  • parameters - Required. The properties for the database.
Success Responses
  • 201 Created - Database created successfully.
  • 200 OK - Database updated successfully.

Delete Database

Deletes a database.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
Success Responses
  • 204 No Content - Database deleted successfully.
  • 200 OK - Successful deletion (response body may contain status).

Servers

List Servers

Retrieves a list of all logical servers in a resource group.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
Success Responses
  • 200 OK - Successfully retrieved the list of servers.

Firewall Rules

List Firewall Rules

Retrieves a list of all firewall rules in a logical server.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
Success Responses
  • 200 OK - Successfully retrieved the list of firewall rules.

Create or Update Firewall Rule

Creates or updates a firewall rule.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{firewallRuleName}
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
  • parameters - Required. The properties for the firewall rule.
Success Responses
  • 200 OK - Firewall rule created or updated successfully.

Elastic Pools

List Elastic Pools

Retrieves a list of all elastic pools in a logical server.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
Success Responses
  • 200 OK - Successfully retrieved the list of elastic pools.

Operations

List Operations

Lists all of the available operations for the Microsoft.Sql resource provider.

GET /providers/Microsoft.Sql/operations
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
Success Responses
  • 200 OK - Successfully retrieved the list of operations.

Restorable Dropped Databases

List Restorable Dropped Databases

Returns a list of databases that are dropped and can be restored.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/restorableDroppedDatabases
Parameters
  • api-version - Required. The API version to use for the request. (e.g., 2022-05-01)
Success Responses
  • 200 OK - Successfully retrieved the list of restorable dropped databases.