Skip to main content
Feedback

Microsoft Azure Cosmos DB connector

The Microsoft Azure Cosmos DB connector allows you to transfer data to and from a Microsoft Azure Cosmos DB server using Integration and REST APIs. These REST APIs provide access to Microsoft Azure Cosmos DB resources to Get, Update, Delete, Create, Upsert, and Query documents from Collections and Databases.

A primary key or a resource token governs the APIs. To access a resource, include the selected token in the REST authorization header, as part of the authorization string.

Primary Key Tokens - The primary key token is the all-access key token that allows users to have full control of Microsoft Azure Cosmos DB resources in an account. Creating an account generates the primary key.

Resource Tokens - You create resource tokens when you set up users in a database with access permissions for precise access control on a resource, also known as a permission resource. A permission resource contains a hash resource token constructed with the information regarding the resource path and access type a user has access to. The permission resource token is time-bound, and the validity period can be overridden.

The Microsoft Azure Cosmos DB connector processes input data and output data in JSON format only.

note

  • The maximum size for the input file is 1MB. The connector will throw an error if the file size exceeds 1MB. Boomi recommendeds using the “Try/Catch step” to catch the failed input files and to list them to the user.

  • This is an open source connector and you can access the code in the Microsoft Azure Cosmos DB connector repository.

Connector configuration

To configure the connector to communicate with Microsoft Azure Cosmos DB, set up two components:

  • Microsoft Azure Cosmos DB connection - The connection represents the Cosmos DB server in Microsoft Azure
  • Microsoft Azure Cosmos DB operation - The operation represents an action against a specific record type. You will create one or more operations, one for each type of interaction required by your integration scenario.

This design provides reusable components containing connection settings and operation settings. After building the connection and operation, set up your connector within a process. When you configure the process properly, Boomi Integration can transfer data from/to Microsoft Azure Cosmos DB.

Supported editions

This connector supports the Rest APIs version 2017-02-22 from the Azure Cosmos DB: Rest API Reference.

Prerequisites

To use the connector and implement a connection to your Microsoft Azure Cosmos DB server from Boomi Integration, ensure you have the following:

  • Hostname or URL for the Microsoft Azure Cosmos DB server.

  • Deployed basic runtime on your local machine or host it with Boomi Integration.

  • A Microsoft Azure account for using Microsoft Azure Cosmos DB, with the necessary credentials to access Microsoft Azure Cosmos DB APIs. You also need one of the following key tokens:

    • Primary Key Tokens

    • Resource Tokens

Tracked properties

This connector has no predefined tracked properties. Refer to the topic Adding tracked fields to a connector operation to learn how to add a custom tracked field.

On this Page