Azure Cosmos DB policy
A Azure Cosmos DB policy contains the connection details that are used by a Azure Cosmos DB Request node when you connect to the Azure Cosmos DB application.
Use a Azure Cosmos DB Request node to connect to Azure Cosmos DB and issue requests to work with objects such as Items. The Azure Cosmos DB policy controls, at run time, access to the Azure Cosmos DB application.
The Azure Cosmos DB policy is created when you
configure a connection between a Azure Cosmos DB Request node
and Azure Cosmos DB by using the Connector Discovery
wizard. During the process of discovery, account credentials are stored in the vault and connection
details are stored in an Azure Cosmos DB policy. The
policy is created with a type of Azure Cosmos DB, and the name of the policy is
returned to the node and specified in the Connection tab, in the format
{policyProjectName}:policyName.
You can also create, update, or delete a Azure Cosmos DB policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM® App Connect Enterprise Toolkit and then clicking .
You must deploy this policy before message flows that use the policy are started. If you redeploy an Azure Cosmos DB policy, all message flows that are using the policy will be stopped and restarted.
For more information about using Azure Cosmos DB, see Using Azure Cosmos DB with IBM App Connect Enterprise.
| Property | Property name in .policyxml file | Description of properties |
|---|---|---|
| Azure Cosmos DB Application Type | applicationType | This property is reserved for future use and must be set to the value
online. |
| Azure Cosmos DB Application Version | applicationVersion | This property is reserved for future use and must be set to the value
v1. |
| Azure Cosmos DB Authentication method | authenticationMethod | This property specifies the type of authentication that is used for the
connection between IBM App Connect Enterprise and Azure Cosmos DB. This value is reserved for future use and
must be set to BASIC_API_KEY. |
| Server URL | apiUrl | Specify the URL for the API server that makes runtime calls. |
| Credential Name | credentialName | The name of your Azure Cosmos DB
account. For example, azurecosmosdbpolicy_AzureCosmosDB1 |