Cosmos DB Connector Help

Version: 2

Authentication :: ApiKey [Http]


Description

No description available

Instructions

Connecting to your Azure Cosmos DB data requires you to authenticate your REST API access. Follow the instructions below:
  1. Go to your Azure portal homepage: https://portal.azure.com/
  2. In the search bar at the top of the homepage, enter Azure Cosmos DB. In the dropdown that appears, select Azure Cosmos DB.
  3. Click on the name of the database account you want to connect to. (Also copy and paste the name of the database account for later use.)
  4. On the next page where you can see all of the database account information, look along the left side and select Keys.
  5. On the Keys page, you will have two tabs: Read-write Keys and Read-only Keys. If you are going to write data to your database, you need to remain on the Read-write Keys tab. If you are only going to read data from your database, you should select the Read-only Keys tab.
  6. On the Keys page, copy the PRIMARY KEY value and paste it somewhere for later use. (The SECONDARY KEY value may also be copied and pasted instead of PRIMARY KEY.)
  7. Back at the connector screen, enter the primary or secondary key you recorded in step 6 into the Primary or Secondary Key field.
  8. Enter the database account you recorded in step 3 into the Database Account field.
  9. Enter or select the default database you want to connect to using the Defualt Database field.
  10. Enter or select the default table (i.e. container/collection) you want to connect to using the Default Table (Container/Collection) field.
  11. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure Devops account.
  12. If the connection test succeeds, select OK.

Parameters

Parameter Label Required Options Description Help
Password Primary or Secondary Key YES
Account Account Name (Case-Sensitive) YES Login to your Cosmos DB Page and look in the title (copy that name). URL usually ends with /databaseAccounts/your-cosmos-db-account/overview
Database Database Name (keep blank to use default) Case-Sensitive YES Leave blank to use default DB set on connection screen
Table Default Table (needed to invoke #DirectSQL) NO
ApiVersion API Version YES
Option Value
2020-07-15 2020-07-15
2015-08-06 2015-08-06