BizTalk Adapter for Cosmos DB

Build 21.0.7930

Establishing a Connection

To access Cosmos DB data in BizTalk, you need to configure the adapter and then configure the connection.

Configure the Cosmos DB Adapter

You can configure the adapter in the properties for the receive location or send port: Select the adapter in the Type menu, and then click Configure. You can then specify receive or transmit properties in the Transport Properties dialog that is displayed.

See Adapter Configuration for guides to configure the adapter for receive locations and send ports.

Configure the Connection

After you configure the adapter, you need to configure connection properties. In the Transport Properties dialog, click the button in the Connection String box. You can set connection properties in the dialog that is displayed.

Connecting to Cosmos DB


To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

  • AccountEndpoint: The value should be the Cosmos DB account URL from the Keys blade of the Cosmos DB account.
  • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set Token to this value.
  • TokenType: (Optional) Set this to 'master' if you are using a Master Token, which is a full permissions token generated during account creation. Otherwise, set this property to 'resource' if you are using a Resource Token, which is custom permissions token generated when a database user is set up. The default value is 'master'. Check the TokenType connection property description for more details.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930