How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Databases API

Operations for managing Cosmos DB databases

Microsoft Azure Databases API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Databases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 31 operations across 21 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

Requests are made against a single base URL, https://{accountName}.documents.azure.com.

31 operations 21 paths 37 schemas 4 DELETE11 GET2 PATCH11 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Server
https://{accountName}.documents.azure.com
Resource Areas
1

Paths & Operations 31

Across 21 paths, the API surfaces 31 operations — 4 DELETE, 11 GET, 2 PATCH, 11 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Databases 31

Operations for managing Cosmos DB databases

GET
/dbs
Microsoft Azure List Databases
Databases_List 3 params → 200default
POST
/dbs
Microsoft Azure Create a Database
Databases_Create 1 param body → 201409default
GET
/dbs/{databaseId}
Microsoft Azure Get a Database
Databases_Get 2 params → 200404default
DELETE
/dbs/{databaseId}
Microsoft Azure Delete a Database
Databases_Delete 2 params → 204404default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/databases
Microsoft Azure Gets A List Of Databases In The Migrate Project
microsoftAzureDatabasesEnumeratedatabases 7 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/databases/{databaseName}
Microsoft Azure Gets A Database In The Migrate Project
microsoftAzureDatabasesGetdatabase 6 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/usages
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Databases Databasename Usages
microsoftAzureDatabaseusagesListbydatabase 5 params → 200
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Checknameavailability
microsoftAzureDatabasesChecknameavailability 4 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases
microsoftAzureDatabasesListbycluster 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename
microsoftAzureDatabasesGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename
microsoftAzureDatabasesCreateorupdate 5 params body → 200201202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename
microsoftAzureDatabasesUpdate 5 params body → 200201202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename
microsoftAzureDatabasesDelete 5 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Listprincipals
microsoftAzureDatabasesListprincipals 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Addprincipals
microsoftAzureDatabasesAddprincipals 5 params body → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Databases Databasename Removeprincipals
microsoftAzureDatabasesRemoveprincipals 5 params body → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername Databases Databasename
microsoftAzureDatabasesCreateorupdate 5 params body → 200201202
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername Databases Databasename
microsoftAzureDatabasesDelete 5 params → 200202204
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername Databases Databasename
microsoftAzureDatabasesGet 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername Databases
microsoftAzureDatabasesListbyserver 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases
microsoftAzureDatabasesListbycluster 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
microsoftAzureDatabasesCreate 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
microsoftAzureDatabasesUpdate 5 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
microsoftAzureDatabasesGet 5 params → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
microsoftAzureDatabasesDelete 5 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/listKeys
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Listkeys
microsoftAzureDatabasesListkeys 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Regeneratekey
microsoftAzureDatabasesRegeneratekey 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/import
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Import
microsoftAzureDatabasesImport 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/export
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Export
microsoftAzureDatabasesExport 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/forceUnlink
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Forceunlink
microsoftAzureDatabasesForceunlink 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/flush
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Flush
microsoftAzureDatabasesFlush 5 params body → 200202default

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are DatabaseAssessmentDetails (14 properties), Database (7 properties), DatabaseProperties_4 (7 properties), DatabaseUsage (7 properties). Each schema is shown below with its type and property counts.

DatabaseUpdate_2
object
A partial update to the RedisEnterprise database
1 property
Database_2
object
Database REST resource.
4 properties
DatabaseProperties_2
object
Class representing the Kusto database properties.
4 properties 1 required
Database
object
A Cosmos DB database resource.
7 properties 1 required
RegenerateKeyParameters
object
Specifies which access keys to reset to a new random value.
1 property 1 required
DatabaseList
object
The response of a list-all operation.
2 properties
Database_4
object
Describes a database on the RedisEnterprise cluster
1 property
Database_3
object
Represents a Database.
1 property
CheckNameResult
object
3 properties
DatabaseUsageListResult
object
The response to a list database metrics request.
1 property 1 required
DatabaseStatistics
object
1 property
ImportClusterParameters
object
Parameters for a Redis Enterprise import operation.
1 property 1 required
AccessKeys
object
The secret access keys used for authenticating connections to redis
2 properties
ForceUnlinkParameters
object
Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation.
1 property 1 required
DatabasePrincipalListRequest
object
The list Kusto database principals operation request.
1 property
DatabaseListResult
object
List of Cosmos DB databases.
3 properties
DatabaseCollection
object
Collection of databases.
2 properties
DatabaseUsage
object
The database usages.
7 properties
DatabaseUpdate
object
Class representing an update to a Kusto database.
3 properties
DatabaseCheckNameRequest
object
2 properties 2 required
ExportClusterParameters
object
Parameters for a Redis Enterprise export operation.
1 property 1 required
DatabaseAssessmentDetails
object
Assessment properties that can be shared by various publishers.
14 properties
ResourceState
string
Current resource status
ProvisioningState
string
Current provisioning status
DatabaseListResult_2_2
object
A List of databases.
1 property
Module
object
Specifies configuration of a redis module
3 properties 1 required
DatabaseProperties_3
object
The properties of a database.
2 properties
DatabasePrincipalListResult
object
The list Kusto database principals operation response.
1 property
FlushParameters
object
Parameters for a Redis Enterprise active geo-replication flush operation
1 property
Database_2_2
object
Class representing a Kusto database.
2 properties
DatabasePrincipal
object
6 properties 3 required
CloudErrorBody
object
An error response from Kusto.
4 properties
DatabaseProperties
object
Properties of the database resource.
2 properties
DatabaseProperties_4
object
Properties of RedisEnterprise databases, as opposed to general resource properties like location, tags
7 properties
DatabaseListResult_2
object
The list Kusto databases operation response.
1 property
ErrorResponse
object
Error response from Cosmos DB.
2 properties 2 required
CloudError
object
An error response from Kusto.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-databases-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Databases API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.