Skip to main content

Azure Cosmos DB

REST API reference: Cosmos DB Resource Provider – 2024-11-15

Legend: ✅ Implemented  |  ❌ Not implemented

Control Plane

Database Accounts

OperationStatusNotes
Create Or UpdatePUT /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.DocumentDB/databaseAccounts/{name}
GetGET /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.DocumentDB/databaseAccounts/{name}
DeleteDELETE /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.DocumentDB/databaseAccounts/{name}
UpdatePATCH /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.DocumentDB/databaseAccounts/{name}
List By Resource GroupGET /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.DocumentDB/databaseAccounts
ListGET /subscriptions/{sub}/providers/Microsoft.DocumentDB/databaseAccounts
List KeysPOST .../databaseAccounts/{name}/listKeys
List Read-Only KeysPOST .../databaseAccounts/{name}/readonlykeys
Regenerate KeyPOST .../databaseAccounts/{name}/regenerateKey
List Connection StringsPOST .../databaseAccounts/{name}/listConnectionStrings

SQL Databases

OperationStatusNotes
Create Or UpdatePUT .../databaseAccounts/{name}/sqlDatabases/{database}
GetGET .../databaseAccounts/{name}/sqlDatabases/{database}
DeleteDELETE .../databaseAccounts/{name}/sqlDatabases/{database}
ListGET .../databaseAccounts/{name}/sqlDatabases
Get ThroughputGET .../sqlDatabases/{database}/throughputSettings/default
Update ThroughputPUT .../sqlDatabases/{database}/throughputSettings/default

SQL Containers

OperationStatusNotes
Create Or UpdatePUT .../sqlDatabases/{database}/containers/{container}
GetGET .../sqlDatabases/{database}/containers/{container}
DeleteDELETE .../sqlDatabases/{database}/containers/{container}
ListGET .../sqlDatabases/{database}/containers
Get ThroughputGET .../containers/{container}/throughputSettings/default
Update ThroughputPUT .../containers/{container}/throughputSettings/default

Data Plane

REST API reference: Cosmos DB REST API

Databases

OperationStatusNotes
Create DatabasePOST /{dbs}
Get DatabaseGET /{dbs}/{db}
Delete DatabaseDELETE /{dbs}/{db}
List DatabasesGET /{dbs}

Collections

OperationStatusNotes
Create CollectionPOST /{dbs}/{db}/colls
Get CollectionGET /{dbs}/{db}/colls/{coll}
Replace CollectionPUT /{dbs}/{db}/colls/{coll}
Delete CollectionDELETE /{dbs}/{db}/colls/{coll}
List CollectionsGET /{dbs}/{db}/colls

Documents

OperationStatusNotes
Create DocumentPOST /{dbs}/{db}/colls/{coll}/docs
Get DocumentGET /{dbs}/{db}/colls/{coll}/docs/{docId}
Replace DocumentPUT /{dbs}/{db}/colls/{coll}/docs/{docId}
Patch DocumentPATCH /{dbs}/{db}/colls/{coll}/docs/{docId}
Delete DocumentDELETE /{dbs}/{db}/colls/{coll}/docs/{docId}
List DocumentsGET /{dbs}/{db}/colls/{coll}/docs
Query DocumentsPOST /{dbs}/{db}/colls/{coll}/docs with x-ms-documentdb-isquery: true
Star on GitHub