Azure Cosmos DB agent

Target Azure Cosmos DB

Prerequisites

To have Gluesync working on your Azure Cosmos DB instance you will need to have:

Valid Azure Cosmos DB Service key and an instance of the Azure Cosmos DB.

Setup via Web UI

Hostname / IP Address: Hostname of your Azure DB service.
Port: Optional, defaults to 443.
Database name: Name of your source Namespace.

Custom host credentials

This can be also set via Rest API by specifying customHostCredentials param.

Azure Key: The key of you Azure Cosmos DB service.
Container: The name of the target container.

Specific configuration

This agent has no specific configuration properties.

Setup via Rest APIs

Here following an example of calling the CoreHub’s Rest API via curl to setup the connection for this Agent.

Connect the agent

curl --location --request PUT 'http://core-hub-ip-address/pipelines/{pipelineId}/agents/{agentId}/config/credentials' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
        "hostCredentials": {
        "connectionName": "myAgentNickName",
        "host": "host-address",
        "port": 443
    },
    "customHostCredentials": {
        "azureKey": "XYZ",
        "container": "container_name"
    }
}'

Azure Cosmos DB entity names

For further details, please refer to the official Azure Cosmos DB documentation at this link: learn.microsoft.com/en-us/azure/cosmos-db/introduction/