Cosmos DB Connector
Documentation
Version: 2
Documentation

EndPoints for Cosmos DB Connector


On this page you will see possible API actions you can perform with Cosmos DB connector. We will refer this as API EndPoint or just EndPoint.

Label Name Description
Get List of Databases get_databases Gets a list of the databases in the current database account. [API reference]
Get Database Information by Id or Name get_database Gets a database by its Id. [API reference]
Get List of Tables get_tables Gets a list of the tables in the database. (Tables are also called 'containers' or 'collections') [API reference]
Get table information by Id or Name get_table Gets a table by its Id. (Tables are also called 'containers' or 'collections') [API reference]
Get table partition key ranges get_partition_keyranges Gets Partition Key Ranges for a table. This is useful for query if you want to minimize scan to specific partition (Tables are also called 'containers' or 'collections')
Query documents using Cosmos DB SQL query language query_documents Gets data based on the specified SQL query. [API reference]
Get All Documents for a Table get_documents Gets all documents for a Table. [API reference]
Get Document by Id get_document Gets Document by Id. [API reference]
Delete a Document by Id delete_document Deletes a Document by Id. [API reference]
Get All Users for a Database get_users Gets all users for a Database. [API reference]
Get User by Id or Name get_user Gets database user information for a specific Id [API reference]
Create User for Database create_user Create a new user which you can later use to create permission set and obtain resource token. [API reference]
Create a document in the container create_document Insert JSON document in Cosmos DB Container. [API reference]
Upsert a document in the container upsert_document Insert JSON document in Cosmos DB Container. [API reference]
Update Document in the Container update_document Update full or part of the document in Cosmos DB Container. [API reference]
Create Permission Token for a User (One Table) create_token Create a new user which you can later use to create permission set and obtain resource token. [API reference]
Generic Request generic_request This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.
Generic Request (Bulk Write) generic_request_bulk_write This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.