---
schema_version: "1"
id: f379b486f62843e6625af51f9329c4862f4a1fd6ad42706647f973e54c4e3a65
title: Using Anypoint Studio to Configure Azure Cosmos DB 1.0
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/azure-cosmos-db-connector/1.0/azure-cosmos-db-connector-studio.md
canonical_url: https://docs.mulesoft.com/azure-cosmos-db-connector/1.0/azure-cosmos-db-connector-studio
source_site: docs.mulesoft.com
content_type: documentation
content_hash: b2d878cef89f8625fd5d0ca7172ed4a9cba08fb9166085c198b687d0ebeabd25
description: MuleSoft Documentation Site
release: "1.0"
latest: false
---
---
product: Azure Cosmos DB Connector
version: 1.0
---

# Using Anypoint Studio to Configure Azure Cosmos DB 1.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-input-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, refer to
the [Azure Cosmos DB Connector Reference](https://docs.mulesoft.com/azure-cosmos-db-connector/1.0/azure-cosmos-db-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Anypoint Connector for Azure Cosmos DB (Azure Cosmos DB Connector) to your Mule project to
automatically populate the XML code with the connector’s namespace and schema location and add the
required dependencies to the project’s `pom.xml` file:

1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

2.  In the **Add Dependencies to Project** window, type `azure cosmos db` in the search field.

3.  Click **Azure Cosmos DB Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Azure Cosmos DB:

- HTTP Listener  
  Initiates a flow each time it receives a request on the configured host and port

- Scheduler  
  Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener source, follow these steps:

1.  In the **Mule Palette** view, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the HTTP Listener source in the app.

6.  On the **General** tab, specify the connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Azure Cosmos DB Connector, follow these steps:

1.  In the **Mule Palette** view, select **Azure Cosmos DB** and then select the desired operation.

2.  Drag the operation onto the Studio canvas to the right of the source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target Azure Cosmos DB system. Azure Cosmos DB Connector
supports Key Token authentication and Resource Token authentication.

To configure the global element for Azure Cosmos DB Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the configuration screen for the operation, click the plus sign (**+**) next to the
    **Connector configuration** field to access the global element configuration fields.

3.  On the **General** tab, in **Connection**, select the authentication method to configure.

    - Select [Key Token Config](#key-token) to configure Key Token authentication.

    - Select [Resource Token Config](#resource-token) to configure Resource Token authentication.

    You can reference a configuration file that contains ANT-style property placeholders
    (recommended), or you can enter your authorization credentials in the global configuration
    properties. For information about the benefits of using property placeholders and how to
    configure them, refer to
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

4.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

5.  Click **Test Connection** to confirm that Mule can connect with the specified server.

6.  Click **OK**.

### Key Token Authentication

Enter the following information on the **General** tab of the **Global Element Properties** screen
to configure Key Token authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Configuration name.</p></div></div></td></tr><tr><td><p><strong>Database account url</strong></p></td><td><div><div><p>Database account URL.</p></div></div></td></tr><tr><td><p><strong>Key token</strong></p></td><td><div><div><p>All access key token that enables users to have full control of the Cosmos DB resources.</p></div></div></td></tr><tr><td><p><strong>Version</strong></p></td><td><div><div><p>Version of the Cosmos DB REST service.</p></div></div></td></tr></tbody></table>

### Resource Token Authentication

Enter the following information on the **General** tab of the **Global Element Properties** screen
to configure Resource Token authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Configuration name.</p></div></div></td></tr><tr><td><p><strong>Database account url</strong></p></td><td><div><div><p>Database account URL.</p></div></div></td></tr><tr><td><p><strong>Resource token</strong></p></td><td><div><div><p>Resource token.</p></div></div></td></tr><tr><td><p><strong>Version</strong></p></td><td><div><div><p>Version of the Cosmos DB REST service.</p></div></div></td></tr></tbody></table>

## Configure Additional Connector Fields

After you configure a global element for Azure Cosmos DB Connector, configure the other required
fields for the connector. The required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  OS console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Azure Cosmos DB Reference](https://docs.mulesoft.com/azure-cosmos-db-connector/1.0/azure-cosmos-db-connector-reference)

- [Salesforce Help](https://help.salesforce.com)
