Azure Database APIs

Explore the comprehensive set of REST APIs for managing and interacting with Azure Database services. This documentation provides details on authentication, endpoints, request/response formats, and best practices for integrating Azure databases into your applications.

Core Database Management APIs

Azure SQL Database Management API

Manage your Azure SQL Database instances, including creation, deletion, scaling, and configuration.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases
List databases in a specific SQL Server.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
Create or update a database.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
Delete a database.

Example: Get Databases


GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases?api-version=2022-05-01
Authorization: Bearer 
Host: management.azure.com

Azure Cosmos DB Management API

Manage your Azure Cosmos DB accounts, databases, and containers. Supports various APIs like SQL (Core), MongoDB, Cassandra, Gremlin, and Table.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts
List all Cosmos DB accounts in a resource group.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/default/databases
Create a database within a Cosmos DB account.

Example: Create a Cosmos DB Database (SQL API)


POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/apis/default/databases?api-version=2021-05-15
Content-Type: application/json
Authorization: Bearer 
Host: management.azure.com

{
  "id": "myCosmosDbDatabase"
}

Azure Database for PostgreSQL Management API

Provision, configure, and manage Azure Database for PostgreSQL servers and their configurations.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}
Create or update a PostgreSQL server.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}
Get details of a specific PostgreSQL database.

Azure Database for MySQL Management API

Manage Azure Database for MySQL servers, including creating, deleting, scaling, and configuring backups.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers
List MySQL servers in a resource group.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules
Create or update a firewall rule for a MySQL server.

Data Plane APIs

These APIs allow you to interact with the data stored within your database instances. Usage of data plane APIs typically requires specific database credentials or connection strings.

Azure Cosmos DB Data API (SQL API)

Perform CRUD operations on documents within your Cosmos DB SQL API containers.

POST /dbs/{databaseName}/colls/{collectionName}/docs
Create a new document.

201 Created
GET /dbs/{databaseName}/colls/{collectionName}/docs/{documentId}
Retrieve a specific document.

200 OK
PUT /dbs/{databaseName}/colls/{collectionName}/docs/{documentId}
Replace an existing document.

200 OK
DELETE /dbs/{databaseName}/colls/{collectionName}/docs/{documentId}
Delete a document.

204 No Content

Example: Get Document


POST https://mycosmosdbaccount.documents.azure.com/dbs/myDatabase/colls/myCollection/docs?&_sp=rid&...
x-ms-version: 2018-12-01
Authorization: type=master&ver=1.0&sig=
x-ms-date: Tue, 26 Mar 2024 10:00:00 GMT
Content-Type: application/json
Host: mycosmosdbaccount.documents.azure.com

{
  "id": "myDocumentId"
}

Azure SQL Database Query API (via ODBC/JDBC)

While not a direct REST API in the same sense as management APIs, Azure SQL Database provides standard interfaces like ODBC and JDBC that allow applications to send SQL queries and retrieve results. SDKs abstract these protocols for common programming languages.

Use Azure SDKs for .NET, Java, Python, Node.js for programmatic access.
Connect via standard SQL clients using connection strings provided by Azure.

Authentication and Authorization

Most Azure Database APIs utilize Azure Active Directory (Azure AD) for authentication. Management plane operations require appropriate role-based access control (RBAC) permissions. Data plane operations may use Azure AD or database-specific authentication methods (e.g., master keys for Cosmos DB).

Management Plane: OAuth 2.0 tokens obtained from Azure AD.
Data Plane (Cosmos DB): Resource tokens or master keys.
Data Plane (SQL DB, PostgreSQL, MySQL): Connection strings often include username/password or integrated Azure AD authentication.

Key Concepts

Resource Provider: The service that exposes Azure resources (e.g., Microsoft.Sql, Microsoft.DocumentDB).
API Version: Specifies the version of the API to use, ensuring backward compatibility and consistent behavior.
Subscription ID: Your Azure subscription identifier.
Resource Group: A logical container for Azure resources.
RBAC: Role-Based Access Control for managing permissions on Azure resources.

For detailed API references, error codes, and SDK samples, please refer to the specific service documentation.

Azure SQL REST API Reference

Azure Cosmos DB REST API Reference